client/src/assets/player/peertube-player-manager.ts

   1 import '@peertube/videojs-contextmenu'
   2 import './shared/upnext/end-card'
   3 import './shared/upnext/upnext-plugin'
   4 import './shared/stats/stats-card'
   5 import './shared/stats/stats-plugin'
   6 import './shared/bezels/bezels-plugin'
   7 import './shared/peertube/peertube-plugin'
   8 import './shared/resolutions/peertube-resolutions-plugin'
   9 import './shared/control-bar/next-previous-video-button'
  10 import './shared/control-bar/p2p-info-button'
  11 import './shared/control-bar/peertube-link-button'
  12 import './shared/control-bar/peertube-load-progress-bar'
  13 import './shared/control-bar/theater-button'
  14 import './shared/settings/resolution-menu-button'
  15 import './shared/settings/resolution-menu-item'
  16 import './shared/settings/settings-dialog'
  17 import './shared/settings/settings-menu-button'
  18 import './shared/settings/settings-menu-item'
  19 import './shared/settings/settings-panel'
  20 import './shared/settings/settings-panel-child'
  21 import './shared/playlist/playlist-plugin'
  22 import './shared/mobile/peertube-mobile-plugin'
  23 import './shared/mobile/peertube-mobile-buttons'
  24 import './shared/hotkeys/peertube-hotkeys-plugin'
  25 import './shared/metrics/metrics-plugin'
  26 import videojs from 'video.js'
  27 import { logger } from '@root-helpers/logger'
  28 import { PluginsManager } from '@root-helpers/plugins-manager'
  29 import { isMobile } from '@root-helpers/web-browser'
  30 import { saveAverageBandwidth } from './peertube-player-local-storage'
  31 import { ManagerOptionsBuilder } from './shared/manager-options'
  32 import { TranslationsManager } from './translations-manager'
  33 import { CommonOptions, PeertubePlayerManagerOptions, PlayerMode, PlayerNetworkInfo } from './types'
  34
  35 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
  36 (videojs.getComponent('PlaybackRateMenuButton') as any).prototype.controlText_ = 'Speed'
  37
  38 const CaptionsButton = videojs.getComponent('CaptionsButton') as any
  39 // Change Captions to Subtitles/CC
  40 CaptionsButton.prototype.controlText_ = 'Subtitles/CC'
  41 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
  42 CaptionsButton.prototype.label_ = ' '
  43
  44 export class PeertubePlayerManager {
  45   private static playerElementClassName: string
  46   private static onPlayerChange: (player: videojs.Player) => void
  47   private static alreadyPlayed = false
  48   private static pluginsManager: PluginsManager
  49
  50   private static videojsDecodeErrors = 0
  51
  52   private static p2pMediaLoaderModule: any
  53
  54   static initState () {
  55     this.alreadyPlayed = false
  56   }
  57
  58   static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: videojs.Player) => void) {
  59     this.pluginsManager = options.pluginsManager
  60
  61     this.onPlayerChange = onPlayerChange
  62     this.playerElementClassName = options.common.playerElement.className
  63
  64     if (mode === 'webtorrent') await import('./shared/webtorrent/webtorrent-plugin')
  65     if (mode === 'p2p-media-loader') {
  66       const [ p2pMediaLoaderModule ] = await Promise.all([
  67         import('@peertube/p2p-media-loader-hlsjs'),
  68         import('./shared/p2p-media-loader/p2p-media-loader-plugin')
  69       ])
  70
  71       this.p2pMediaLoaderModule = p2pMediaLoaderModule
  72     }
  73
  74     await TranslationsManager.loadLocaleInVideoJS(options.common.serverUrl, options.common.language, videojs)
  75
  76     return this.buildPlayer(mode, options)
  77   }
  78
  79   private static async buildPlayer (mode: PlayerMode, options: PeertubePlayerManagerOptions): Promise<videojs.Player> {
  80     const videojsOptionsBuilder = new ManagerOptionsBuilder(mode, options, this.p2pMediaLoaderModule)
  81
  82     const videojsOptions = await this.pluginsManager.runHook(
  83       'filter:internal.player.videojs.options.result',
  84       videojsOptionsBuilder.getVideojsOptions(this.alreadyPlayed)
  85     )
  86
  87     const self = this
  88     return new Promise(res => {
  89       videojs(options.common.playerElement, videojsOptions, function (this: videojs.Player) {
  90         const player = this
  91
  92         let alreadyFallback = false
  93
  94         const handleError = () => {
  95           if (alreadyFallback) return
  96           alreadyFallback = true
  97
  98           if (mode === 'p2p-media-loader') {
  99             self.tryToRecoverHLSError(player.error(), player, options)
 100           } else {
 101             self.maybeFallbackToWebTorrent(mode, player, options)
 102           }
 103         }
 104
 105         player.one('error', () => handleError())
 106
 107         player.one('play', () => {
 108           self.alreadyPlayed = true
 109         })
 110
 111         self.addContextMenu(videojsOptionsBuilder, player, options.common)
 112
 113         if (isMobile()) player.peertubeMobile()
 114         if (options.common.enableHotkeys === true) player.peerTubeHotkeysPlugin()
 115         if (options.common.controlBar === false) player.controlBar.addClass('control-bar-hidden')
 116
 117         player.bezels()
 118
 119         player.stats({
 120           videoUUID: options.common.videoUUID,
 121           videoIsLive: options.common.isLive,
 122           mode,
 123           p2pEnabled: options.common.p2pEnabled
 124         })
 125
 126         player.on('p2pInfo', (_, data: PlayerNetworkInfo) => {
 127           if (data.source !== 'p2p-media-loader' || isNaN(data.bandwidthEstimate)) return
 128
 129           saveAverageBandwidth(data.bandwidthEstimate)
 130         })
 131
 132         const offlineNotificationElem = document.createElement('div')
 133         offlineNotificationElem.classList.add('vjs-peertube-offline-notification')
 134         offlineNotificationElem.innerText = player.localize('You seem to be offline and the video may not work')
 135
 136         const handleOnline = () => {
 137           player.el().removeChild(offlineNotificationElem)
 138           logger.info('The browser is online')
 139         }
 140
 141         const handleOffline = () => {
 142           player.el().appendChild(offlineNotificationElem)
 143           logger.info('The browser is offline')
 144         }
 145
 146         window.addEventListener('online', handleOnline)
 147         window.addEventListener('offline', handleOffline)
 148
 149         player.on('dispose', () => {
 150           window.removeEventListener('online', handleOnline)
 151           window.removeEventListener('offline', handleOffline)
 152         })
 153
 154         return res(player)
 155       })
 156     })
 157   }
 158
 159   private static async tryToRecoverHLSError (err: any, currentPlayer: videojs.Player, options: PeertubePlayerManagerOptions) {
 160     if (err.code === 3) { // Decode error
 161
 162       // Display a notification to user
 163       if (this.videojsDecodeErrors === 0) {
 164         options.common.errorNotifier(currentPlayer.localize('The video failed to play, will try to fast forward.'))
 165       }
 166
 167       if (this.videojsDecodeErrors === 20) {
 168         this.maybeFallbackToWebTorrent('p2p-media-loader', currentPlayer, options)
 169         return
 170       }
 171
 172       logger.info('Fast forwarding HLS to recover from an error.')
 173
 174       this.videojsDecodeErrors++
 175
 176       options.common.startTime = currentPlayer.currentTime() + 2
 177       options.common.autoplay = true
 178       this.rebuildAndUpdateVideoElement(currentPlayer, options.common)
 179
 180       const newPlayer = await this.buildPlayer('p2p-media-loader', options)
 181       this.onPlayerChange(newPlayer)
 182     } else {
 183       this.maybeFallbackToWebTorrent('p2p-media-loader', currentPlayer, options)
 184     }
 185   }
 186
 187   private static async maybeFallbackToWebTorrent (
 188     currentMode: PlayerMode,
 189     currentPlayer: videojs.Player,
 190     options: PeertubePlayerManagerOptions
 191   ) {
 192     if (options.webtorrent.videoFiles.length === 0 || currentMode === 'webtorrent') {
 193       currentPlayer.peertube().displayFatalError()
 194       return
 195     }
 196
 197     logger.info('Fallback to webtorrent.')
 198
 199     this.rebuildAndUpdateVideoElement(currentPlayer, options.common)
 200
 201     await import('./shared/webtorrent/webtorrent-plugin')
 202
 203     const newPlayer = await this.buildPlayer('webtorrent', options)
 204     this.onPlayerChange(newPlayer)
 205   }
 206
 207   private static rebuildAndUpdateVideoElement (player: videojs.Player, commonOptions: CommonOptions) {
 208     const newVideoElement = document.createElement('video')
 209     newVideoElement.className = this.playerElementClassName
 210
 211     // VideoJS wraps our video element inside a div
 212     let currentParentPlayerElement = commonOptions.playerElement.parentNode
 213     // Fix on IOS, don't ask me why
 214     if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(commonOptions.playerElement.id).parentNode
 215
 216     currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
 217
 218     commonOptions.playerElement = newVideoElement
 219     commonOptions.onPlayerElementChange(newVideoElement)
 220
 221     player.dispose()
 222
 223     return newVideoElement
 224   }
 225
 226   private static addContextMenu (optionsBuilder: ManagerOptionsBuilder, player: videojs.Player, commonOptions: CommonOptions) {
 227     const options = optionsBuilder.getContextMenuOptions(player, commonOptions)
 228
 229     player.contextmenuUI(options)
 230   }
 231 }
 232
 233 // ############################################################################
 234
 235 export {
 236   videojs
 237 }