1 import 'videojs-hotkeys/videojs.hotkeys'
3 import '@peertube/videojs-contextmenu'
4 import './upnext/end-card'
5 import './upnext/upnext-plugin'
6 import './stats/stats-card'
7 import './stats/stats-plugin'
8 import './bezels/bezels-plugin'
9 import './peertube-plugin'
10 import './peertube-resolutions-plugin'
11 import './videojs-components/next-previous-video-button'
12 import './videojs-components/p2p-info-button'
13 import './videojs-components/peertube-link-button'
14 import './videojs-components/peertube-load-progress-bar'
15 import './videojs-components/resolution-menu-button'
16 import './videojs-components/resolution-menu-item'
17 import './videojs-components/settings-dialog'
18 import './videojs-components/settings-menu-button'
19 import './videojs-components/settings-menu-item'
20 import './videojs-components/settings-panel'
21 import './videojs-components/settings-panel-child'
22 import './videojs-components/theater-button'
23 import './playlist/playlist-plugin'
24 import videojs from 'video.js'
25 import { HlsJsEngineSettings } from '@peertube/p2p-media-loader-hlsjs'
26 import { PluginsManager } from '@root-helpers/plugins-manager'
27 import { buildVideoLink, decorateVideoLink } from '@shared/core-utils'
28 import { isDefaultLocale } from '@shared/core-utils/i18n'
29 import { VideoFile } from '@shared/models'
30 import { copyToClipboard } from '../../root-helpers/utils'
31 import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager'
32 import { segmentUrlBuilderFactory } from './p2p-media-loader/segment-url-builder'
33 import { segmentValidatorFactory } from './p2p-media-loader/segment-validator'
34 import { getAverageBandwidthInStore, saveAverageBandwidth } from './peertube-player-local-storage'
36 NextPreviousVideoButtonOptions,
37 P2PMediaLoaderPluginOptions,
38 PeerTubeLinkButtonOptions,
40 PlaylistPluginOptions,
44 } from './peertube-videojs-typings'
45 import { TranslationsManager } from './translations-manager'
46 import { buildVideoOrPlaylistEmbed, getRtcConfig, isIOS, isSafari } from './utils'
48 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
49 (videojs.getComponent('PlaybackRateMenuButton') as any).prototype.controlText_ = 'Speed'
51 const CaptionsButton = videojs.getComponent('CaptionsButton') as any
52 // Change Captions to Subtitles/CC
53 CaptionsButton.prototype.controlText_ = 'Subtitles/CC'
54 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
55 CaptionsButton.prototype.label_ = ' '
57 export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
59 export type WebtorrentOptions = {
60 videoFiles: VideoFile[]
63 export type P2PMediaLoaderOptions = {
65 segmentsSha256Url: string
66 trackerAnnounce: string[]
67 redundancyBaseUrls: string[]
68 videoFiles: VideoFile[]
71 export interface CustomizationOptions {
72 startTime: number | string
73 stopTime: number | string
84 export interface CommonOptions extends CustomizationOptions {
85 playerElement: HTMLVideoElement
86 onPlayerElementChange: (element: HTMLVideoElement) => void
91 nextVideo?: () => void
92 hasNextVideo?: () => boolean
94 previousVideo?: () => void
95 hasPreviousVideo?: () => boolean
97 playlist?: PlaylistPluginOptions
100 enableHotkeys: boolean
101 inactivityTimeout: number
104 theaterButton: boolean
115 videoCaptions: VideoJSCaption[]
118 videoShortUUID: string
120 userWatching?: UserWatching
125 export type PeertubePlayerManagerOptions = {
126 common: CommonOptions
127 webtorrent: WebtorrentOptions
128 p2pMediaLoader?: P2PMediaLoaderOptions
130 pluginsManager: PluginsManager
133 export class PeertubePlayerManager {
134 private static playerElementClassName: string
135 private static onPlayerChange: (player: videojs.Player) => void
136 private static alreadyPlayed = false
137 private static pluginsManager: PluginsManager
139 static initState () {
140 PeertubePlayerManager.alreadyPlayed = false
143 static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: videojs.Player) => void) {
144 this.pluginsManager = options.pluginsManager
146 let p2pMediaLoader: any
148 this.onPlayerChange = onPlayerChange
149 this.playerElementClassName = options.common.playerElement.className
151 if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
152 if (mode === 'p2p-media-loader') {
153 [ p2pMediaLoader ] = await Promise.all([
154 import('@peertube/p2p-media-loader-hlsjs'),
155 import('./p2p-media-loader/p2p-media-loader-plugin')
159 const videojsOptions = await this.getVideojsOptions(mode, options, p2pMediaLoader)
161 await TranslationsManager.loadLocaleInVideoJS(options.common.serverUrl, options.common.language, videojs)
164 return new Promise(res => {
165 videojs(options.common.playerElement, videojsOptions, function (this: videojs.Player) {
168 let alreadyFallback = false
170 player.tech(true).one('error', () => {
171 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
172 alreadyFallback = true
175 player.one('error', () => {
176 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
177 alreadyFallback = true
180 player.one('play', () => {
181 PeertubePlayerManager.alreadyPlayed = true
184 self.addContextMenu({
187 videoShortUUID: options.common.videoShortUUID,
188 videoEmbedUrl: options.common.embedUrl,
189 videoEmbedTitle: options.common.embedTitle
194 videoUUID: options.common.videoUUID,
195 videoIsLive: options.common.isLive,
199 player.on('p2pInfo', (_, data: PlayerNetworkInfo) => {
200 if (data.source !== 'p2p-media-loader' || isNaN(data.bandwidthEstimate)) return
202 saveAverageBandwidth(data.bandwidthEstimate)
210 private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) {
211 if (currentMode === 'webtorrent') return
213 console.log('Fallback to webtorrent.')
215 const newVideoElement = document.createElement('video')
216 newVideoElement.className = this.playerElementClassName
218 // VideoJS wraps our video element inside a div
219 let currentParentPlayerElement = options.common.playerElement.parentNode
220 // Fix on IOS, don't ask me why
221 if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(options.common.playerElement.id).parentNode
223 currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
225 options.common.playerElement = newVideoElement
226 options.common.onPlayerElementChange(newVideoElement)
230 await import('./webtorrent/webtorrent-plugin')
232 const mode = 'webtorrent'
233 const videojsOptions = await this.getVideojsOptions(mode, options)
236 videojs(newVideoElement, videojsOptions, function (this: videojs.Player) {
239 self.addContextMenu({
242 videoShortUUID: options.common.videoShortUUID,
243 videoEmbedUrl: options.common.embedUrl,
244 videoEmbedTitle: options.common.embedTitle
247 PeertubePlayerManager.onPlayerChange(player)
251 private static async getVideojsOptions (
253 options: PeertubePlayerManagerOptions,
254 p2pMediaLoaderModule?: any
255 ): Promise<videojs.PlayerOptions> {
256 const commonOptions = options.common
257 const isHLS = mode === 'p2p-media-loader'
259 let autoplay = this.getAutoPlayValue(commonOptions.autoplay)
261 preloadTextTracks: false
264 const plugins: VideoJSPluginOptions = {
267 autoplay, // Use peertube plugin autoplay because we could get the file by webtorrent
268 videoViewUrl: commonOptions.videoViewUrl,
269 videoDuration: commonOptions.videoDuration,
270 userWatching: commonOptions.userWatching,
271 subtitle: commonOptions.subtitle,
272 videoCaptions: commonOptions.videoCaptions,
273 stopTime: commonOptions.stopTime,
274 isLive: commonOptions.isLive,
275 videoUUID: commonOptions.videoUUID
279 if (commonOptions.playlist) {
280 plugins.playlist = commonOptions.playlist
283 if (commonOptions.enableHotkeys === true) {
284 PeertubePlayerManager.addHotkeysOptions(plugins)
288 const { hlsjs } = PeertubePlayerManager.addP2PMediaLoaderOptions(plugins, options, p2pMediaLoaderModule)
290 Object.assign(html5, hlsjs.html5)
293 if (mode === 'webtorrent') {
294 PeertubePlayerManager.addWebTorrentOptions(plugins, options)
296 // WebTorrent plugin handles autoplay, because we do some hackish stuff in there
300 const videojsOptions = {
303 // We don't use text track settings for now
304 textTrackSettings: false as any, // FIXME: typings
305 controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
306 loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
308 muted: commonOptions.muted !== undefined
309 ? commonOptions.muted
310 : undefined, // Undefined so the player knows it has to check the local storage
312 autoplay: this.getAutoPlayValue(autoplay),
314 poster: commonOptions.poster,
315 inactivityTimeout: commonOptions.inactivityTimeout,
316 playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2 ],
321 children: this.getControlBarChildren(mode, {
322 videoShortUUID: commonOptions.videoShortUUID,
324 captions: commonOptions.captions,
325 peertubeLink: commonOptions.peertubeLink,
326 theaterButton: commonOptions.theaterButton,
328 nextVideo: commonOptions.nextVideo,
329 hasNextVideo: commonOptions.hasNextVideo,
331 previousVideo: commonOptions.previousVideo,
332 hasPreviousVideo: commonOptions.hasPreviousVideo
333 }) as any // FIXME: typings
337 if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
338 Object.assign(videojsOptions, { language: commonOptions.language })
341 return this.pluginsManager.runHook('filter:internal.player.videojs.options.result', videojsOptions)
344 private static addP2PMediaLoaderOptions (
345 plugins: VideoJSPluginOptions,
346 options: PeertubePlayerManagerOptions,
347 p2pMediaLoaderModule: any
349 const p2pMediaLoaderOptions = options.p2pMediaLoader
350 const commonOptions = options.common
352 const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce
353 .filter(t => t.startsWith('ws'))
355 const redundancyUrlManager = new RedundancyUrlManager(options.p2pMediaLoader.redundancyBaseUrls)
357 const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
358 redundancyUrlManager,
359 type: 'application/x-mpegURL',
360 startTime: commonOptions.startTime,
361 src: p2pMediaLoaderOptions.playlistUrl
364 let consumeOnly = false
365 if ((navigator as any)?.connection?.type === 'cellular') {
366 console.log('We are on a cellular connection: disabling seeding.')
370 const p2pMediaLoaderConfig: HlsJsEngineSettings = {
373 segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url, options.common.isLive),
374 rtcConfig: getRtcConfig(),
375 requiredSegmentsPriority: 1,
376 simultaneousHttpDownloads: 1,
377 segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager, 1),
378 useP2P: commonOptions.p2pEnabled,
382 swarmId: p2pMediaLoaderOptions.playlistUrl
387 levelLabelHandler: (level: { height: number, width: number }) => {
388 const resolution = Math.min(level.height || 0, level.width || 0)
390 const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === resolution)
391 // We don't have files for live videos
392 if (!file) return level.height
394 let label = file.resolution.label
395 if (file.fps >= 50) label += file.fps
400 hlsjsConfig: this.getHLSOptions(p2pMediaLoaderModule, p2pMediaLoaderConfig)
404 const toAssign = { p2pMediaLoader, hlsjs }
405 Object.assign(plugins, toAssign)
410 private static getHLSOptions (p2pMediaLoaderModule: any, p2pMediaLoaderConfig: HlsJsEngineSettings) {
412 capLevelToPlayerSize: true,
413 autoStartLoad: false,
414 liveSyncDurationCount: 5,
416 loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
419 const averageBandwidth = getAverageBandwidthInStore()
420 if (!averageBandwidth) return base
425 abrEwmaDefaultEstimate: averageBandwidth * 8, // We want bit/s
427 testBandwidth: false,
432 private static addWebTorrentOptions (plugins: VideoJSPluginOptions, options: PeertubePlayerManagerOptions) {
433 const commonOptions = options.common
434 const webtorrentOptions = options.webtorrent
435 const p2pMediaLoaderOptions = options.p2pMediaLoader
437 const autoplay = this.getAutoPlayValue(commonOptions.autoplay) === 'play'
441 playerRefusedP2P: commonOptions.p2pEnabled === false,
442 videoDuration: commonOptions.videoDuration,
443 playerElement: commonOptions.playerElement,
444 videoFiles: webtorrentOptions.videoFiles.length !== 0
445 ? webtorrentOptions.videoFiles
446 // The WebTorrent plugin won't be able to play these files, but it will fallback to HTTP mode
447 : p2pMediaLoaderOptions?.videoFiles || [],
448 startTime: commonOptions.startTime
451 Object.assign(plugins, { webtorrent })
454 private static getControlBarChildren (mode: PlayerMode, options: {
455 videoShortUUID: string
457 peertubeLink: boolean
458 theaterButton: boolean
461 nextVideo?: () => void
462 hasNextVideo?: () => boolean
464 previousVideo?: () => void
465 hasPreviousVideo?: () => boolean
467 const settingEntries = []
468 const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
471 settingEntries.push('playbackRateMenuButton')
472 if (options.captions === true) settingEntries.push('captionsButton')
473 settingEntries.push('resolutionMenuButton')
477 if (options.previousVideo) {
478 const buttonOptions: NextPreviousVideoButtonOptions = {
480 handler: options.previousVideo,
482 if (!options.hasPreviousVideo) return false
484 return !options.hasPreviousVideo()
488 Object.assign(children, {
489 previousVideoButton: buttonOptions
493 Object.assign(children, { playToggle: {} })
495 if (options.nextVideo) {
496 const buttonOptions: NextPreviousVideoButtonOptions = {
498 handler: options.nextVideo,
500 if (!options.hasNextVideo) return false
502 return !options.hasNextVideo()
506 Object.assign(children, {
507 nextVideoButton: buttonOptions
511 Object.assign(children, {
512 currentTimeDisplay: {},
517 flexibleWidthSpacer: {},
522 [loadProgressBar]: {},
523 mouseTimeDisplay: {},
539 entries: settingEntries
543 if (options.peertubeLink === true) {
544 Object.assign(children, {
545 peerTubeLinkButton: { shortUUID: options.videoShortUUID } as PeerTubeLinkButtonOptions
549 if (options.theaterButton === true) {
550 Object.assign(children, {
555 Object.assign(children, {
562 private static addContextMenu (options: {
564 player: videojs.Player
565 videoShortUUID: string
566 videoEmbedUrl: string
567 videoEmbedTitle: string
569 const { mode, player, videoEmbedTitle, videoEmbedUrl, videoShortUUID } = options
571 const content = () => {
572 const isLoopEnabled = player.options_['loop']
576 label: player.localize('Play in loop') + (isLoopEnabled ? '<span class="vjs-icon-tick-white"></span>' : ''),
577 listener: function () {
578 player.options_['loop'] = !isLoopEnabled
582 label: player.localize('Copy the video URL'),
583 listener: function () {
584 copyToClipboard(buildVideoLink({ shortUUID: videoShortUUID }))
588 label: player.localize('Copy the video URL at the current time'),
589 listener: function (this: videojs.Player) {
590 const url = buildVideoLink({ shortUUID: videoShortUUID })
592 copyToClipboard(decorateVideoLink({ url, startTime: this.currentTime() }))
597 label: player.localize('Copy embed code'),
599 copyToClipboard(buildVideoOrPlaylistEmbed(videoEmbedUrl, videoEmbedTitle))
604 if (mode === 'webtorrent') {
606 label: player.localize('Copy magnet URI'),
607 listener: function (this: videojs.Player) {
608 copyToClipboard(this.webtorrent().getCurrentVideoFile().magnetUri)
615 label: player.localize('Stats for nerds'),
617 player.stats().show()
621 return items.map(i => ({
623 label: `<span class="vjs-icon-${i.icon || 'link-2'}"></span>` + i.label
628 player.contextmenuUI({ content })
631 private static addHotkeysOptions (plugins: VideoJSPluginOptions) {
632 const isNaked = (event: KeyboardEvent, key: string) =>
633 (!event.ctrlKey && !event.altKey && !event.metaKey && !event.shiftKey && event.key === key)
635 Object.assign(plugins, {
637 skipInitialFocus: true,
638 enableInactiveFocus: false,
639 captureDocumentHotkeys: true,
640 documentHotkeysFocusElementFilter: (e: HTMLElement) => {
641 const tagName = e.tagName.toLowerCase()
642 return e.id === 'content' || tagName === 'body' || tagName === 'video'
645 enableVolumeScroll: false,
646 enableModifiersForNumbers: false,
648 rewindKey: function (event: KeyboardEvent) {
649 return isNaked(event, 'ArrowLeft')
652 forwardKey: function (event: KeyboardEvent) {
653 return isNaked(event, 'ArrowRight')
656 fullscreenKey: function (event: KeyboardEvent) {
657 // fullscreen with the f key or Ctrl+Enter
658 return isNaked(event, 'f') || (!event.altKey && event.ctrlKey && event.key === 'Enter')
662 increasePlaybackRateKey: {
663 key: function (event: KeyboardEvent) {
664 return isNaked(event, '>')
666 handler: function (player: videojs.Player) {
667 const newValue = Math.min(player.playbackRate() + 0.1, 5)
668 player.playbackRate(parseFloat(newValue.toFixed(2)))
671 decreasePlaybackRateKey: {
672 key: function (event: KeyboardEvent) {
673 return isNaked(event, '<')
675 handler: function (player: videojs.Player) {
676 const newValue = Math.max(player.playbackRate() - 0.1, 0.10)
677 player.playbackRate(parseFloat(newValue.toFixed(2)))
681 key: function (event: KeyboardEvent) {
682 return isNaked(event, '.')
684 handler: function (player: videojs.Player) {
686 // Calculate movement distance (assuming 30 fps)
688 player.currentTime(player.currentTime() + dist)
696 private static getAutoPlayValue (autoplay: any) {
697 if (autoplay !== true) return autoplay
699 // On first play, disable autoplay to avoid issues
700 // But if the player already played videos, we can safely autoplay next ones
701 if (isIOS() || isSafari()) {
702 return PeertubePlayerManager.alreadyPlayed ? 'play' : false
709 // ############################################################################