-import { VideoFile } from '../../../../shared/models/videos'
-// @ts-ignore
-import * as videojs from 'video.js'
-import 'videojs-hotkeys'
-import 'videojs-dock'
-import 'videojs-contextmenu-ui'
-import 'videojs-contrib-quality-levels'
-import './peertube-plugin'
-import './videojs-components/peertube-link-button'
-import './videojs-components/resolution-menu-button'
-import './videojs-components/settings-menu-button'
-import './videojs-components/p2p-info-button'
-import './videojs-components/peertube-load-progress-bar'
-import './videojs-components/theater-button'
-import { P2PMediaLoaderPluginOptions, UserWatching, VideoJSCaption, VideoJSPluginOptions, videojsUntyped } from './peertube-videojs-typings'
-import { buildVideoEmbed, buildVideoLink, copyToClipboard } from './utils'
-import { getCompleteLocale, getShortLocale, is18nLocale, isDefaultLocale } from '../../../../shared/models/i18n/i18n'
-import { Engine } from 'p2p-media-loader-hlsjs'
+import '@peertube/videojs-contextmenu'
+import './shared/upnext/end-card'
+import './shared/upnext/upnext-plugin'
+import './shared/stats/stats-card'
+import './shared/stats/stats-plugin'
+import './shared/bezels/bezels-plugin'
+import './shared/peertube/peertube-plugin'
+import './shared/resolutions/peertube-resolutions-plugin'
+import './shared/control-bar/next-previous-video-button'
+import './shared/control-bar/p2p-info-button'
+import './shared/control-bar/peertube-link-button'
+import './shared/control-bar/peertube-load-progress-bar'
+import './shared/control-bar/theater-button'
+import './shared/settings/resolution-menu-button'
+import './shared/settings/resolution-menu-item'
+import './shared/settings/settings-dialog'
+import './shared/settings/settings-menu-button'
+import './shared/settings/settings-menu-item'
+import './shared/settings/settings-panel'
+import './shared/settings/settings-panel-child'
+import './shared/playlist/playlist-plugin'
+import './shared/mobile/peertube-mobile-plugin'
+import './shared/mobile/peertube-mobile-buttons'
+import './shared/hotkeys/peertube-hotkeys-plugin'
+import './shared/metrics/metrics-plugin'
+import videojs from 'video.js'
+import { logger } from '@root-helpers/logger'
+import { PluginsManager } from '@root-helpers/plugins-manager'
+import { isMobile } from '@root-helpers/web-browser'
+import { saveAverageBandwidth } from './peertube-player-local-storage'
+import { ManagerOptionsBuilder } from './shared/manager-options'
+import { TranslationsManager } from './translations-manager'
+import { CommonOptions, PeertubePlayerManagerOptions, PlayerMode, PlayerNetworkInfo } from './types'
// Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
-videojsUntyped.getComponent('PlaybackRateMenuButton').prototype.controlText_ = 'Speed'
+(videojs.getComponent('PlaybackRateMenuButton') as any).prototype.controlText_ = 'Speed'
+
+const CaptionsButton = videojs.getComponent('CaptionsButton') as any
// Change Captions to Subtitles/CC
-videojsUntyped.getComponent('CaptionsButton').prototype.controlText_ = 'Subtitles/CC'
+CaptionsButton.prototype.controlText_ = 'Subtitles/CC'
// We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
-videojsUntyped.getComponent('CaptionsButton').prototype.label_ = ' '
-
-export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
-
-export type WebtorrentOptions = {
- videoFiles: VideoFile[]
-}
-
-export type P2PMediaLoaderOptions = {
- playlistUrl: string
-}
-
-export type CommonOptions = {
- playerElement: HTMLVideoElement
-
- autoplay: boolean
- videoDuration: number
- enableHotkeys: boolean
- inactivityTimeout: number
- poster: string
- startTime: number | string
+CaptionsButton.prototype.label_ = ' '
- theaterMode: boolean
- captions: boolean
- peertubeLink: boolean
-
- videoViewUrl: string
- embedUrl: string
+export class PeertubePlayerManager {
+ private static playerElementClassName: string
+ private static onPlayerChange: (player: videojs.Player) => void
+ private static alreadyPlayed = false
+ private static pluginsManager: PluginsManager
- language?: string
- controls?: boolean
- muted?: boolean
- loop?: boolean
- subtitle?: string
+ private static videojsDecodeErrors = 0
- videoCaptions: VideoJSCaption[]
+ private static p2pMediaLoaderModule: any
- userWatching?: UserWatching
+ static initState () {
+ this.alreadyPlayed = false
+ }
- serverUrl: string
-}
+ static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: videojs.Player) => void) {
+ this.pluginsManager = options.pluginsManager
-export type PeertubePlayerManagerOptions = {
- common: CommonOptions,
- webtorrent?: WebtorrentOptions,
- p2pMediaLoader?: P2PMediaLoaderOptions
-}
+ this.onPlayerChange = onPlayerChange
+ this.playerElementClassName = options.common.playerElement.className
-export class PeertubePlayerManager {
+ if (mode === 'webtorrent') await import('./shared/webtorrent/webtorrent-plugin')
+ if (mode === 'p2p-media-loader') {
+ const [ p2pMediaLoaderModule ] = await Promise.all([
+ import('@peertube/p2p-media-loader-hlsjs'),
+ import('./shared/p2p-media-loader/p2p-media-loader-plugin')
+ ])
- private static videojsLocaleCache: { [ path: string ]: any } = {}
+ this.p2pMediaLoaderModule = p2pMediaLoaderModule
+ }
- static getServerTranslations (serverUrl: string, locale: string) {
- const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
- // It is the default locale, nothing to translate
- if (!path) return Promise.resolve(undefined)
+ await TranslationsManager.loadLocaleInVideoJS(options.common.serverUrl, options.common.language, videojs)
- return fetch(path + '/server.json')
- .then(res => res.json())
- .catch(err => {
- console.error('Cannot get server translations', err)
- return undefined
- })
+ return this.buildPlayer(mode, options)
}
- static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions) {
- if (mode === 'webtorrent') await import('./webtorrent-plugin')
- if (mode === 'p2p-media-loader') await import('./p2p-media-loader-plugin')
-
- const videojsOptions = this.getVideojsOptions(mode, options)
+ private static async buildPlayer (mode: PlayerMode, options: PeertubePlayerManagerOptions): Promise<videojs.Player> {
+ const videojsOptionsBuilder = new ManagerOptionsBuilder(mode, options, this.p2pMediaLoaderModule)
- await this.loadLocaleInVideoJS(options.common.serverUrl, options.common.language)
+ const videojsOptions = await this.pluginsManager.runHook(
+ 'filter:internal.player.videojs.options.result',
+ videojsOptionsBuilder.getVideojsOptions(this.alreadyPlayed)
+ )
const self = this
return new Promise(res => {
- videojs(options.common.playerElement, videojsOptions, function (this: any) {
+ videojs(options.common.playerElement, videojsOptions, function (this: videojs.Player) {
const player = this
- self.addContextMenu(mode, player, options.common.embedUrl)
+ let alreadyFallback = false
- return res(player)
- })
- })
- }
+ const handleError = () => {
+ if (alreadyFallback) return
+ alreadyFallback = true
- private static loadLocaleInVideoJS (serverUrl: string, locale: string) {
- const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
- // It is the default locale, nothing to translate
- if (!path) return Promise.resolve(undefined)
+ if (mode === 'p2p-media-loader') {
+ self.tryToRecoverHLSError(player.error(), player, options)
+ } else {
+ self.maybeFallbackToWebTorrent(mode, player, options)
+ }
+ }
- let p: Promise<any>
+ player.one('error', () => handleError())
- if (PeertubePlayerManager.videojsLocaleCache[path]) {
- p = Promise.resolve(PeertubePlayerManager.videojsLocaleCache[path])
- } else {
- p = fetch(path + '/player.json')
- .then(res => res.json())
- .then(json => {
- PeertubePlayerManager.videojsLocaleCache[path] = json
- return json
+ player.one('play', () => {
+ self.alreadyPlayed = true
})
- .catch(err => {
- console.error('Cannot get player translations', err)
- return undefined
+
+ self.addContextMenu(videojsOptionsBuilder, player, options.common)
+
+ if (isMobile()) player.peertubeMobile()
+ if (options.common.enableHotkeys === true) player.peerTubeHotkeysPlugin()
+ if (options.common.controlBar === false) player.controlBar.addClass('control-bar-hidden')
+
+ player.bezels()
+
+ player.stats({
+ videoUUID: options.common.videoUUID,
+ videoIsLive: options.common.isLive,
+ mode,
+ p2pEnabled: options.common.p2pEnabled
})
- }
- const completeLocale = getCompleteLocale(locale)
- return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json))
- }
+ player.on('p2pInfo', (_, data: PlayerNetworkInfo) => {
+ if (data.source !== 'p2p-media-loader' || isNaN(data.bandwidthEstimate)) return
- private static getVideojsOptions (mode: PlayerMode, options: PeertubePlayerManagerOptions) {
- const commonOptions = options.common
- const webtorrentOptions = options.webtorrent
- const p2pMediaLoaderOptions = options.p2pMediaLoader
- let html5 = {}
-
- const plugins: VideoJSPluginOptions = {
- peertube: {
- autoplay: commonOptions.autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
- videoViewUrl: commonOptions.videoViewUrl,
- videoDuration: commonOptions.videoDuration,
- startTime: commonOptions.startTime,
- userWatching: commonOptions.userWatching,
- subtitle: commonOptions.subtitle,
- videoCaptions: commonOptions.videoCaptions
- }
- }
+ saveAverageBandwidth(data.bandwidthEstimate)
+ })
- if (p2pMediaLoaderOptions) {
- const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
- type: 'application/x-mpegURL',
- src: p2pMediaLoaderOptions.playlistUrl
- }
+ const offlineNotificationElem = document.createElement('div')
+ offlineNotificationElem.classList.add('vjs-peertube-offline-notification')
+ offlineNotificationElem.innerText = player.localize('You seem to be offline and the video may not work')
- const config = {
- segments: {
- swarmId: 'swarm' // TODO: choose swarm id
+ const handleOnline = () => {
+ player.el().removeChild(offlineNotificationElem)
+ logger.info('The browser is online')
}
- }
- const streamrootHls = {
- html5: {
- hlsjsConfig: {
- liveSyncDurationCount: 7,
- loader: new Engine(config).createLoaderClass()
- }
- }
- }
- Object.assign(plugins, { p2pMediaLoader, streamrootHls })
- html5 = streamrootHls.html5
- }
+ const handleOffline = () => {
+ player.el().appendChild(offlineNotificationElem)
+ logger.info('The browser is offline')
+ }
- if (webtorrentOptions) {
- const webtorrent = {
- autoplay: commonOptions.autoplay,
- videoDuration: commonOptions.videoDuration,
- playerElement: commonOptions.playerElement,
- videoFiles: webtorrentOptions.videoFiles
- }
- Object.assign(plugins, { webtorrent })
- }
+ window.addEventListener('online', handleOnline)
+ window.addEventListener('offline', handleOffline)
- const videojsOptions = {
- html5,
-
- // We don't use text track settings for now
- textTrackSettings: false,
- controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
- loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
-
- muted: commonOptions.muted !== undefined
- ? commonOptions.muted
- : undefined, // Undefined so the player knows it has to check the local storage
-
- poster: commonOptions.poster,
- autoplay: false,
- inactivityTimeout: commonOptions.inactivityTimeout,
- playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
- plugins,
- controlBar: {
- children: this.getControlBarChildren(mode, {
- captions: commonOptions.captions,
- peertubeLink: commonOptions.peertubeLink,
- theaterMode: commonOptions.theaterMode
+ player.on('dispose', () => {
+ window.removeEventListener('online', handleOnline)
+ window.removeEventListener('offline', handleOffline)
})
- }
- }
- if (commonOptions.enableHotkeys === true) {
- Object.assign(videojsOptions.plugins, {
- hotkeys: {
- enableVolumeScroll: false,
- enableModifiersForNumbers: false,
-
- fullscreenKey: function (event: KeyboardEvent) {
- // fullscreen with the f key or Ctrl+Enter
- return event.key === 'f' || (event.ctrlKey && event.key === 'Enter')
- },
-
- seekStep: function (event: KeyboardEvent) {
- // mimic VLC seek behavior, and default to 5 (original value is 5).
- if (event.ctrlKey && event.altKey) {
- return 5 * 60
- } else if (event.ctrlKey) {
- return 60
- } else if (event.altKey) {
- return 10
- } else {
- return 5
- }
- },
-
- customKeys: {
- increasePlaybackRateKey: {
- key: function (event: KeyboardEvent) {
- return event.key === '>'
- },
- handler: function (player: videojs.Player) {
- player.playbackRate((player.playbackRate() + 0.1).toFixed(2))
- }
- },
- decreasePlaybackRateKey: {
- key: function (event: KeyboardEvent) {
- return event.key === '<'
- },
- handler: function (player: videojs.Player) {
- player.playbackRate((player.playbackRate() - 0.1).toFixed(2))
- }
- },
- frameByFrame: {
- key: function (event: KeyboardEvent) {
- return event.key === '.'
- },
- handler: function (player: videojs.Player) {
- player.pause()
- // Calculate movement distance (assuming 30 fps)
- const dist = 1 / 30
- player.currentTime(player.currentTime() + dist)
- }
- }
- }
- }
+ return res(player)
})
- }
+ })
+ }
- if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
- Object.assign(videojsOptions, { language: commonOptions.language })
- }
+ private static async tryToRecoverHLSError (err: any, currentPlayer: videojs.Player, options: PeertubePlayerManagerOptions) {
+ if (err.code === 3) { // Decode error
- return videojsOptions
- }
+ // Display a notification to user
+ if (this.videojsDecodeErrors === 0) {
+ options.common.errorNotifier(currentPlayer.localize('The video failed to play, will try to fast forward.'))
+ }
- private static getControlBarChildren (mode: PlayerMode, options: {
- peertubeLink: boolean
- theaterMode: boolean,
- captions: boolean
- }) {
- const settingEntries = []
- const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
-
- // Keep an order
- settingEntries.push('playbackRateMenuButton')
- if (options.captions === true) settingEntries.push('captionsButton')
- settingEntries.push('resolutionMenuButton')
-
- const children = {
- 'playToggle': {},
- 'currentTimeDisplay': {},
- 'timeDivider': {},
- 'durationDisplay': {},
- 'liveDisplay': {},
-
- 'flexibleWidthSpacer': {},
- 'progressControl': {
- children: {
- 'seekBar': {
- children: {
- [loadProgressBar]: {},
- 'mouseTimeDisplay': {},
- 'playProgressBar': {}
- }
- }
- }
- },
+ if (this.videojsDecodeErrors === 20) {
+ this.maybeFallbackToWebTorrent('p2p-media-loader', currentPlayer, options)
+ return
+ }
- 'p2PInfoButton': {},
+ logger.info('Fast forwarding HLS to recover from an error.')
- 'muteToggle': {},
- 'volumeControl': {},
+ this.videojsDecodeErrors++
- 'settingsButton': {
- setup: {
- maxHeightOffset: 40
- },
- entries: settingEntries
- }
- }
+ options.common.startTime = currentPlayer.currentTime() + 2
+ options.common.autoplay = true
+ this.rebuildAndUpdateVideoElement(currentPlayer, options.common)
- if (options.peertubeLink === true) {
- Object.assign(children, {
- 'peerTubeLinkButton': {}
- })
+ const newPlayer = await this.buildPlayer('p2p-media-loader', options)
+ this.onPlayerChange(newPlayer)
+ } else {
+ this.maybeFallbackToWebTorrent('p2p-media-loader', currentPlayer, options)
}
+ }
- if (options.theaterMode === true) {
- Object.assign(children, {
- 'theaterButton': {}
- })
+ private static async maybeFallbackToWebTorrent (
+ currentMode: PlayerMode,
+ currentPlayer: videojs.Player,
+ options: PeertubePlayerManagerOptions
+ ) {
+ if (options.webtorrent.videoFiles.length === 0 || currentMode === 'webtorrent') {
+ currentPlayer.peertube().displayFatalError()
+ return
}
- Object.assign(children, {
- 'fullscreenToggle': {}
- })
+ logger.info('Fallback to webtorrent.')
- return children
- }
+ this.rebuildAndUpdateVideoElement(currentPlayer, options.common)
- private static addContextMenu (mode: PlayerMode, player: any, videoEmbedUrl: string) {
- const content = [
- {
- label: player.localize('Copy the video URL'),
- listener: function () {
- copyToClipboard(buildVideoLink())
- }
- },
- {
- label: player.localize('Copy the video URL at the current time'),
- listener: function () {
- const player = this as videojs.Player
- copyToClipboard(buildVideoLink(player.currentTime()))
- }
- },
- {
- label: player.localize('Copy embed code'),
- listener: () => {
- copyToClipboard(buildVideoEmbed(videoEmbedUrl))
- }
- }
- ]
-
- if (mode === 'webtorrent') {
- content.push({
- label: player.localize('Copy magnet URI'),
- listener: function () {
- const player = this as videojs.Player
- copyToClipboard(player.webtorrent().getCurrentVideoFile().magnetUri)
- }
- })
- }
+ await import('./shared/webtorrent/webtorrent-plugin')
- player.contextmenuUI({ content })
+ const newPlayer = await this.buildPlayer('webtorrent', options)
+ this.onPlayerChange(newPlayer)
}
- private static getLocalePath (serverUrl: string, locale: string) {
- const completeLocale = getCompleteLocale(locale)
+ private static rebuildAndUpdateVideoElement (player: videojs.Player, commonOptions: CommonOptions) {
+ const newVideoElement = document.createElement('video')
+ newVideoElement.className = this.playerElementClassName
+
+ // VideoJS wraps our video element inside a div
+ let currentParentPlayerElement = commonOptions.playerElement.parentNode
+ // Fix on IOS, don't ask me why
+ if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(commonOptions.playerElement.id).parentNode
+
+ currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
+
+ commonOptions.playerElement = newVideoElement
+ commonOptions.onPlayerElementChange(newVideoElement)
+
+ player.dispose()
+
+ return newVideoElement
+ }
- if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined
+ private static addContextMenu (optionsBuilder: ManagerOptionsBuilder, player: videojs.Player, commonOptions: CommonOptions) {
+ const options = optionsBuilder.getContextMenuOptions(player, commonOptions)
- return serverUrl + '/client/locales/' + completeLocale
+ player.contextmenuUI(options)
}
}
projects / github / Chocobozzz / PeerTube.git / blobdiff