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