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

   1 import { VideoFile } from '../../../../shared/models/videos'
   2 // @ts-ignore
   3 import * as videojs from 'video.js'
   4 import 'videojs-hotkeys'
   5 import 'videojs-dock'
   6 import 'videojs-contextmenu-ui'
   7 import 'videojs-contrib-quality-levels'
   8 import './peertube-plugin'
   9 import './videojs-components/peertube-link-button'
  10 import './videojs-components/resolution-menu-button'
  11 import './videojs-components/settings-menu-button'
  12 import './videojs-components/p2p-info-button'
  13 import './videojs-components/peertube-load-progress-bar'
  14 import './videojs-components/theater-button'
  15 import { P2PMediaLoaderPluginOptions, UserWatching, VideoJSCaption, VideoJSPluginOptions, videojsUntyped } from './peertube-videojs-typings'
  16 import { buildVideoEmbed, buildVideoLink, copyToClipboard, getRtcConfig } from './utils'
  17 import { getCompleteLocale, getShortLocale, is18nLocale, isDefaultLocale } from '../../../../shared/models/i18n/i18n'
  18 import { segmentValidatorFactory } from './p2p-media-loader/segment-validator'
  19 import { segmentUrlBuilderFactory } from './p2p-media-loader/segment-url-builder'
  20 import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager'
  21 import { getStoredP2PEnabled } from './peertube-player-local-storage'
  22
  23 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
  24 videojsUntyped.getComponent('PlaybackRateMenuButton').prototype.controlText_ = 'Speed'
  25 // Change Captions to Subtitles/CC
  26 videojsUntyped.getComponent('CaptionsButton').prototype.controlText_ = 'Subtitles/CC'
  27 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
  28 videojsUntyped.getComponent('CaptionsButton').prototype.label_ = ' '
  29
  30 export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
  31
  32 export type WebtorrentOptions = {
  33   videoFiles: VideoFile[]
  34 }
  35
  36 export type P2PMediaLoaderOptions = {
  37   playlistUrl: string
  38   segmentsSha256Url: string
  39   trackerAnnounce: string[]
  40   redundancyBaseUrls: string[]
  41   videoFiles: VideoFile[]
  42 }
  43
  44 export interface CustomizationOptions {
  45   startTime: number | string
  46   stopTime: number | string
  47
  48   controls?: boolean
  49   muted?: boolean
  50   loop?: boolean
  51   subtitle?: string
  52
  53   peertubeLink: boolean
  54 }
  55
  56 export interface CommonOptions extends CustomizationOptions {
  57   playerElement: HTMLVideoElement
  58   onPlayerElementChange: (element: HTMLVideoElement) => void
  59
  60   autoplay: boolean
  61   videoDuration: number
  62   enableHotkeys: boolean
  63   inactivityTimeout: number
  64   poster: string
  65
  66   theaterButton: boolean
  67   captions: boolean
  68
  69   videoViewUrl: string
  70   embedUrl: string
  71
  72   language?: string
  73
  74   videoCaptions: VideoJSCaption[]
  75
  76   userWatching?: UserWatching
  77
  78   serverUrl: string
  79 }
  80
  81 export type PeertubePlayerManagerOptions = {
  82   common: CommonOptions,
  83   webtorrent: WebtorrentOptions,
  84   p2pMediaLoader?: P2PMediaLoaderOptions
  85 }
  86
  87 export class PeertubePlayerManager {
  88
  89   private static videojsLocaleCache: { [ path: string ]: any } = {}
  90   private static playerElementClassName: string
  91   private static onPlayerChange: (player: any) => void
  92
  93   static getServerTranslations (serverUrl: string, locale: string) {
  94     const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
  95     // It is the default locale, nothing to translate
  96     if (!path) return Promise.resolve(undefined)
  97
  98     return fetch(path + '/server.json')
  99       .then(res => res.json())
 100       .catch(err => {
 101         console.error('Cannot get server translations', err)
 102         return undefined
 103       })
 104   }
 105
 106   static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: any) => void) {
 107     let p2pMediaLoader: any
 108
 109     this.onPlayerChange = onPlayerChange
 110     this.playerElementClassName = options.common.playerElement.className
 111
 112     if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
 113     if (mode === 'p2p-media-loader') {
 114       [ p2pMediaLoader ] = await Promise.all([
 115         import('p2p-media-loader-hlsjs'),
 116         import('./p2p-media-loader/p2p-media-loader-plugin')
 117       ])
 118     }
 119
 120     const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader)
 121
 122     await this.loadLocaleInVideoJS(options.common.serverUrl, options.common.language)
 123
 124     const self = this
 125     return new Promise(res => {
 126       videojs(options.common.playerElement, videojsOptions, function (this: any) {
 127         const player = this
 128
 129         let alreadyFallback = false
 130
 131         player.tech_.one('error', () => {
 132           if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
 133           alreadyFallback = true
 134         })
 135
 136         player.one('error', () => {
 137           if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
 138           alreadyFallback = true
 139         })
 140
 141         self.addContextMenu(mode, player, options.common.embedUrl)
 142
 143         return res(player)
 144       })
 145     })
 146   }
 147
 148   private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) {
 149     if (currentMode === 'webtorrent') return
 150
 151     console.log('Fallback to webtorrent.')
 152
 153     const newVideoElement = document.createElement('video')
 154     newVideoElement.className = this.playerElementClassName
 155
 156     // VideoJS wraps our video element inside a div
 157     let currentParentPlayerElement = options.common.playerElement.parentNode
 158     // Fix on IOS, don't ask me why
 159     if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(options.common.playerElement.id).parentNode
 160
 161     currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
 162
 163     options.common.playerElement = newVideoElement
 164     options.common.onPlayerElementChange(newVideoElement)
 165
 166     player.dispose()
 167
 168     await import('./webtorrent/webtorrent-plugin')
 169
 170     const mode = 'webtorrent'
 171     const videojsOptions = this.getVideojsOptions(mode, options)
 172
 173     const self = this
 174     videojs(newVideoElement, videojsOptions, function (this: any) {
 175       const player = this
 176
 177       self.addContextMenu(mode, player, options.common.embedUrl)
 178
 179       PeertubePlayerManager.onPlayerChange(player)
 180     })
 181   }
 182
 183   private static loadLocaleInVideoJS (serverUrl: string, locale: string) {
 184     const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
 185     // It is the default locale, nothing to translate
 186     if (!path) return Promise.resolve(undefined)
 187
 188     let p: Promise<any>
 189
 190     if (PeertubePlayerManager.videojsLocaleCache[path]) {
 191       p = Promise.resolve(PeertubePlayerManager.videojsLocaleCache[path])
 192     } else {
 193       p = fetch(path + '/player.json')
 194         .then(res => res.json())
 195         .then(json => {
 196           PeertubePlayerManager.videojsLocaleCache[path] = json
 197           return json
 198         })
 199         .catch(err => {
 200           console.error('Cannot get player translations', err)
 201           return undefined
 202         })
 203     }
 204
 205     const completeLocale = getCompleteLocale(locale)
 206     return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json))
 207   }
 208
 209   private static getVideojsOptions (mode: PlayerMode, options: PeertubePlayerManagerOptions, p2pMediaLoaderModule?: any) {
 210     const commonOptions = options.common
 211
 212     let autoplay = commonOptions.autoplay
 213     let html5 = {}
 214
 215     const plugins: VideoJSPluginOptions = {
 216       peertube: {
 217         mode,
 218         autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
 219         videoViewUrl: commonOptions.videoViewUrl,
 220         videoDuration: commonOptions.videoDuration,
 221         userWatching: commonOptions.userWatching,
 222         subtitle: commonOptions.subtitle,
 223         videoCaptions: commonOptions.videoCaptions,
 224         stopTime: commonOptions.stopTime
 225       }
 226     }
 227
 228     if (commonOptions.enableHotkeys === true) {
 229       PeertubePlayerManager.addHotkeysOptions(plugins)
 230     }
 231
 232     if (mode === 'p2p-media-loader') {
 233       const { streamrootHls } = PeertubePlayerManager.addP2PMediaLoaderOptions(plugins, options, p2pMediaLoaderModule)
 234
 235       html5 = streamrootHls.html5
 236     }
 237
 238     if (mode === 'webtorrent') {
 239       PeertubePlayerManager.addWebTorrentOptions(plugins, options)
 240
 241       // WebTorrent plugin handles autoplay, because we do some hackish stuff in there
 242       autoplay = false
 243     }
 244
 245     const videojsOptions = {
 246       html5,
 247
 248       // We don't use text track settings for now
 249       textTrackSettings: false,
 250       controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
 251       loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
 252
 253       muted: commonOptions.muted !== undefined
 254         ? commonOptions.muted
 255         : undefined, // Undefined so the player knows it has to check the local storage
 256
 257       autoplay: autoplay === true
 258         ? 'any' // Use 'any' instead of true to get notifier by videojs if autoplay fails
 259         : autoplay,
 260
 261       poster: commonOptions.poster,
 262       inactivityTimeout: commonOptions.inactivityTimeout,
 263       playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
 264
 265       plugins,
 266
 267       controlBar: {
 268         children: this.getControlBarChildren(mode, {
 269           captions: commonOptions.captions,
 270           peertubeLink: commonOptions.peertubeLink,
 271           theaterButton: commonOptions.theaterButton
 272         })
 273       }
 274     }
 275
 276     if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
 277       Object.assign(videojsOptions, { language: commonOptions.language })
 278     }
 279
 280     return videojsOptions
 281   }
 282
 283   private static addP2PMediaLoaderOptions (
 284     plugins: VideoJSPluginOptions,
 285     options: PeertubePlayerManagerOptions,
 286     p2pMediaLoaderModule: any
 287   ) {
 288     const p2pMediaLoaderOptions = options.p2pMediaLoader
 289     const commonOptions = options.common
 290
 291     const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce
 292                                                  .filter(t => t.startsWith('ws'))
 293
 294     const redundancyUrlManager = new RedundancyUrlManager(options.p2pMediaLoader.redundancyBaseUrls)
 295
 296     const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
 297       redundancyUrlManager,
 298       type: 'application/x-mpegURL',
 299       startTime: commonOptions.startTime,
 300       src: p2pMediaLoaderOptions.playlistUrl
 301     }
 302
 303     let consumeOnly = false
 304     // FIXME: typings
 305     if (navigator && (navigator as any).connection && (navigator as any).connection.effectiveType === 'cellular') {
 306       console.log('We are on a cellular connection: disabling seeding.')
 307       consumeOnly = true
 308     }
 309
 310     const p2pMediaLoaderConfig = {
 311       loader: {
 312         trackerAnnounce,
 313         segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url),
 314         rtcConfig: getRtcConfig(),
 315         requiredSegmentsPriority: 5,
 316         segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager),
 317         useP2P: getStoredP2PEnabled(),
 318         consumeOnly
 319       },
 320       segments: {
 321         swarmId: p2pMediaLoaderOptions.playlistUrl
 322       }
 323     }
 324     const streamrootHls = {
 325       levelLabelHandler: (level: { height: number, width: number }) => {
 326         const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === level.height)
 327
 328         let label = file.resolution.label
 329         if (file.fps >= 50) label += file.fps
 330
 331         return label
 332       },
 333       html5: {
 334         hlsjsConfig: {
 335           capLevelToPlayerSize: true,
 336           autoStartLoad: false,
 337           liveSyncDurationCount: 7,
 338           loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
 339         }
 340       }
 341     }
 342
 343     const toAssign = { p2pMediaLoader, streamrootHls }
 344     Object.assign(plugins, toAssign)
 345
 346     return toAssign
 347   }
 348
 349   private static addWebTorrentOptions (plugins: VideoJSPluginOptions, options: PeertubePlayerManagerOptions) {
 350     const commonOptions = options.common
 351     const webtorrentOptions = options.webtorrent
 352
 353     const webtorrent = {
 354       autoplay: commonOptions.autoplay,
 355       videoDuration: commonOptions.videoDuration,
 356       playerElement: commonOptions.playerElement,
 357       videoFiles: webtorrentOptions.videoFiles,
 358       startTime: commonOptions.startTime
 359     }
 360
 361     Object.assign(plugins, { webtorrent })
 362   }
 363
 364   private static getControlBarChildren (mode: PlayerMode, options: {
 365     peertubeLink: boolean
 366     theaterButton: boolean,
 367     captions: boolean
 368   }) {
 369     const settingEntries = []
 370     const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
 371
 372     // Keep an order
 373     settingEntries.push('playbackRateMenuButton')
 374     if (options.captions === true) settingEntries.push('captionsButton')
 375     settingEntries.push('resolutionMenuButton')
 376
 377     const children = {
 378       'playToggle': {},
 379       'currentTimeDisplay': {},
 380       'timeDivider': {},
 381       'durationDisplay': {},
 382       'liveDisplay': {},
 383
 384       'flexibleWidthSpacer': {},
 385       'progressControl': {
 386         children: {
 387           'seekBar': {
 388             children: {
 389               [loadProgressBar]: {},
 390               'mouseTimeDisplay': {},
 391               'playProgressBar': {}
 392             }
 393           }
 394         }
 395       },
 396
 397       'p2PInfoButton': {},
 398
 399       'muteToggle': {},
 400       'volumeControl': {},
 401
 402       'settingsButton': {
 403         setup: {
 404           maxHeightOffset: 40
 405         },
 406         entries: settingEntries
 407       }
 408     }
 409
 410     if (options.peertubeLink === true) {
 411       Object.assign(children, {
 412         'peerTubeLinkButton': {}
 413       })
 414     }
 415
 416     if (options.theaterButton === true) {
 417       Object.assign(children, {
 418         'theaterButton': {}
 419       })
 420     }
 421
 422     Object.assign(children, {
 423       'fullscreenToggle': {}
 424     })
 425
 426     return children
 427   }
 428
 429   private static addContextMenu (mode: PlayerMode, player: any, videoEmbedUrl: string) {
 430     const content = [
 431       {
 432         label: player.localize('Copy the video URL'),
 433         listener: function () {
 434           copyToClipboard(buildVideoLink())
 435         }
 436       },
 437       {
 438         label: player.localize('Copy the video URL at the current time'),
 439         listener: function () {
 440           const player = this as videojs.Player
 441           copyToClipboard(buildVideoLink({ startTime: player.currentTime() }))
 442         }
 443       },
 444       {
 445         label: player.localize('Copy embed code'),
 446         listener: () => {
 447           copyToClipboard(buildVideoEmbed(videoEmbedUrl))
 448         }
 449       }
 450     ]
 451
 452     if (mode === 'webtorrent') {
 453       content.push({
 454         label: player.localize('Copy magnet URI'),
 455         listener: function () {
 456           const player = this as videojs.Player
 457           copyToClipboard(player.webtorrent().getCurrentVideoFile().magnetUri)
 458         }
 459       })
 460     }
 461
 462     player.contextmenuUI({ content })
 463   }
 464
 465   private static addHotkeysOptions (plugins: VideoJSPluginOptions) {
 466     Object.assign(plugins, {
 467       hotkeys: {
 468         enableVolumeScroll: false,
 469         enableModifiersForNumbers: false,
 470
 471         fullscreenKey: function (event: KeyboardEvent) {
 472           // fullscreen with the f key or Ctrl+Enter
 473           return event.key === 'f' || (event.ctrlKey && event.key === 'Enter')
 474         },
 475
 476         seekStep: function (event: KeyboardEvent) {
 477           // mimic VLC seek behavior, and default to 5 (original value is 5).
 478           if (event.ctrlKey && event.altKey) {
 479             return 5 * 60
 480           } else if (event.ctrlKey) {
 481             return 60
 482           } else if (event.altKey) {
 483             return 10
 484           } else {
 485             return 5
 486           }
 487         },
 488
 489         customKeys: {
 490           increasePlaybackRateKey: {
 491             key: function (event: KeyboardEvent) {
 492               return event.key === '>'
 493             },
 494             handler: function (player: videojs.Player) {
 495               player.playbackRate((player.playbackRate() + 0.1).toFixed(2))
 496             }
 497           },
 498           decreasePlaybackRateKey: {
 499             key: function (event: KeyboardEvent) {
 500               return event.key === '<'
 501             },
 502             handler: function (player: videojs.Player) {
 503               player.playbackRate((player.playbackRate() - 0.1).toFixed(2))
 504             }
 505           },
 506           frameByFrame: {
 507             key: function (event: KeyboardEvent) {
 508               return event.key === '.'
 509             },
 510             handler: function (player: videojs.Player) {
 511               player.pause()
 512               // Calculate movement distance (assuming 30 fps)
 513               const dist = 1 / 30
 514               player.currentTime(player.currentTime() + dist)
 515             }
 516           }
 517         }
 518       }
 519     })
 520   }
 521
 522   private static getLocalePath (serverUrl: string, locale: string) {
 523     const completeLocale = getCompleteLocale(locale)
 524
 525     if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined
 526
 527     return serverUrl + '/client/locales/' + completeLocale
 528   }
 529 }
 530
 531 // ############################################################################
 532
 533 export {
 534   videojs
 535 }