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