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