1 import 'videojs-hotkeys/videojs.hotkeys'
3 import 'videojs-contextmenu-ui'
4 import 'videojs-contrib-quality-levels'
5 import './upnext/end-card'
6 import './upnext/upnext-plugin'
7 import './bezels/bezels-plugin'
8 import './peertube-plugin'
9 import './videojs-components/next-previous-video-button'
10 import './videojs-components/p2p-info-button'
11 import './videojs-components/peertube-link-button'
12 import './videojs-components/peertube-load-progress-bar'
13 import './videojs-components/resolution-menu-button'
14 import './videojs-components/resolution-menu-item'
15 import './videojs-components/settings-dialog'
16 import './videojs-components/settings-menu-button'
17 import './videojs-components/settings-menu-item'
18 import './videojs-components/settings-panel'
19 import './videojs-components/settings-panel-child'
20 import './videojs-components/theater-button'
21 import './playlist/playlist-plugin'
22 import videojs from 'video.js'
23 import { isDefaultLocale } from '@shared/core-utils/i18n'
24 import { VideoFile } from '@shared/models'
25 import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager'
26 import { segmentUrlBuilderFactory } from './p2p-media-loader/segment-url-builder'
27 import { segmentValidatorFactory } from './p2p-media-loader/segment-validator'
28 import { getStoredP2PEnabled } from './peertube-player-local-storage'
30 NextPreviousVideoButtonOptions,
31 P2PMediaLoaderPluginOptions,
32 PlaylistPluginOptions,
36 } from './peertube-videojs-typings'
37 import { TranslationsManager } from './translations-manager'
38 import { buildVideoOrPlaylistEmbed, buildVideoLink, getRtcConfig, isSafari, isIOS } from './utils'
39 import { copyToClipboard } from '../../root-helpers/utils'
41 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
42 (videojs.getComponent('PlaybackRateMenuButton') as any).prototype.controlText_ = 'Speed'
44 const CaptionsButton = videojs.getComponent('CaptionsButton') as any
45 // Change Captions to Subtitles/CC
46 CaptionsButton.prototype.controlText_ = 'Subtitles/CC'
47 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
48 CaptionsButton.prototype.label_ = ' '
50 export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
52 export type WebtorrentOptions = {
53 videoFiles: VideoFile[]
56 export type P2PMediaLoaderOptions = {
58 segmentsSha256Url: string
59 trackerAnnounce: string[]
60 redundancyBaseUrls: string[]
61 videoFiles: VideoFile[]
64 export interface CustomizationOptions {
65 startTime: number | string
66 stopTime: number | string
77 export interface CommonOptions extends CustomizationOptions {
78 playerElement: HTMLVideoElement
79 onPlayerElementChange: (element: HTMLVideoElement) => void
83 nextVideo?: () => void
84 hasNextVideo?: () => boolean
86 previousVideo?: () => void
87 hasPreviousVideo?: () => boolean
89 playlist?: PlaylistPluginOptions
92 enableHotkeys: boolean
93 inactivityTimeout: number
96 theaterButton: boolean
107 videoCaptions: VideoJSCaption[]
109 userWatching?: UserWatching
114 export type PeertubePlayerManagerOptions = {
115 common: CommonOptions,
116 webtorrent: WebtorrentOptions,
117 p2pMediaLoader?: P2PMediaLoaderOptions
120 export class PeertubePlayerManager {
121 private static playerElementClassName: string
122 private static onPlayerChange: (player: videojs.Player) => void
124 private static alreadyPlayed = false
126 static initState () {
127 PeertubePlayerManager.alreadyPlayed = false
130 static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: videojs.Player) => void) {
131 let p2pMediaLoader: any
133 this.onPlayerChange = onPlayerChange
134 this.playerElementClassName = options.common.playerElement.className
136 if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
137 if (mode === 'p2p-media-loader') {
138 [ p2pMediaLoader ] = await Promise.all([
139 import('p2p-media-loader-hlsjs'),
140 import('./p2p-media-loader/p2p-media-loader-plugin')
144 const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader)
146 await TranslationsManager.loadLocaleInVideoJS(options.common.serverUrl, options.common.language, videojs)
149 return new Promise(res => {
150 videojs(options.common.playerElement, videojsOptions, function (this: videojs.Player) {
153 let alreadyFallback = false
155 player.tech(true).one('error', () => {
156 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
157 alreadyFallback = true
160 player.one('error', () => {
161 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
162 alreadyFallback = true
165 player.one('play', () => {
166 PeertubePlayerManager.alreadyPlayed = true
169 self.addContextMenu(mode, player, options.common.embedUrl, options.common.embedTitle)
178 private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) {
179 if (currentMode === 'webtorrent') return
181 console.log('Fallback to webtorrent.')
183 const newVideoElement = document.createElement('video')
184 newVideoElement.className = this.playerElementClassName
186 // VideoJS wraps our video element inside a div
187 let currentParentPlayerElement = options.common.playerElement.parentNode
188 // Fix on IOS, don't ask me why
189 if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(options.common.playerElement.id).parentNode
191 currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
193 options.common.playerElement = newVideoElement
194 options.common.onPlayerElementChange(newVideoElement)
198 await import('./webtorrent/webtorrent-plugin')
200 const mode = 'webtorrent'
201 const videojsOptions = this.getVideojsOptions(mode, options)
204 videojs(newVideoElement, videojsOptions, function (this: videojs.Player) {
207 self.addContextMenu(mode, player, options.common.embedUrl, options.common.embedTitle)
209 PeertubePlayerManager.onPlayerChange(player)
213 private static getVideojsOptions (
215 options: PeertubePlayerManagerOptions,
216 p2pMediaLoaderModule?: any
217 ): videojs.PlayerOptions {
218 const commonOptions = options.common
219 const isHLS = mode === 'p2p-media-loader'
221 let autoplay = this.getAutoPlayValue(commonOptions.autoplay)
224 const plugins: VideoJSPluginOptions = {
227 autoplay, // Use peertube plugin autoplay because we could get the file by webtorrent
228 videoViewUrl: commonOptions.videoViewUrl,
229 videoDuration: commonOptions.videoDuration,
230 userWatching: commonOptions.userWatching,
231 subtitle: commonOptions.subtitle,
232 videoCaptions: commonOptions.videoCaptions,
233 stopTime: commonOptions.stopTime,
234 isLive: commonOptions.isLive
238 if (commonOptions.playlist) {
239 plugins.playlist = commonOptions.playlist
242 if (commonOptions.enableHotkeys === true) {
243 PeertubePlayerManager.addHotkeysOptions(plugins)
247 const { hlsjs } = PeertubePlayerManager.addP2PMediaLoaderOptions(plugins, options, p2pMediaLoaderModule)
252 if (mode === 'webtorrent') {
253 PeertubePlayerManager.addWebTorrentOptions(plugins, options)
255 // WebTorrent plugin handles autoplay, because we do some hackish stuff in there
259 const videojsOptions = {
262 // We don't use text track settings for now
263 textTrackSettings: false as any, // FIXME: typings
264 controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
265 loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
267 muted: commonOptions.muted !== undefined
268 ? commonOptions.muted
269 : undefined, // Undefined so the player knows it has to check the local storage
271 autoplay: this.getAutoPlayValue(autoplay),
273 poster: commonOptions.poster,
274 inactivityTimeout: commonOptions.inactivityTimeout,
275 playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2 ],
280 children: this.getControlBarChildren(mode, {
281 captions: commonOptions.captions,
282 peertubeLink: commonOptions.peertubeLink,
283 theaterButton: commonOptions.theaterButton,
285 nextVideo: commonOptions.nextVideo,
286 hasNextVideo: commonOptions.hasNextVideo,
288 previousVideo: commonOptions.previousVideo,
289 hasPreviousVideo: commonOptions.hasPreviousVideo
290 }) as any // FIXME: typings
294 if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
295 Object.assign(videojsOptions, { language: commonOptions.language })
298 return videojsOptions
301 private static addP2PMediaLoaderOptions (
302 plugins: VideoJSPluginOptions,
303 options: PeertubePlayerManagerOptions,
304 p2pMediaLoaderModule: any
306 const p2pMediaLoaderOptions = options.p2pMediaLoader
307 const commonOptions = options.common
309 const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce
310 .filter(t => t.startsWith('ws'))
312 const redundancyUrlManager = new RedundancyUrlManager(options.p2pMediaLoader.redundancyBaseUrls)
314 const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
315 redundancyUrlManager,
316 type: 'application/x-mpegURL',
317 startTime: commonOptions.startTime,
318 src: p2pMediaLoaderOptions.playlistUrl
321 let consumeOnly = false
323 if (navigator && (navigator as any).connection && (navigator as any).connection.type === 'cellular') {
324 console.log('We are on a cellular connection: disabling seeding.')
328 const p2pMediaLoaderConfig = {
331 segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url, options.common.isLive),
332 rtcConfig: getRtcConfig(),
333 requiredSegmentsPriority: 1,
334 segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager),
335 useP2P: getStoredP2PEnabled(),
339 swarmId: p2pMediaLoaderOptions.playlistUrl
343 levelLabelHandler: (level: { height: number, width: number }) => {
344 const resolution = Math.min(level.height || 0, level.width || 0)
346 const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === resolution)
347 // We don't have files for live videos
348 if (!file) return level.height
350 let label = file.resolution.label
351 if (file.fps >= 50) label += file.fps
357 capLevelToPlayerSize: true,
358 autoStartLoad: false,
359 liveSyncDurationCount: 5,
360 loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
365 const toAssign = { p2pMediaLoader, hlsjs }
366 Object.assign(plugins, toAssign)
371 private static addWebTorrentOptions (plugins: VideoJSPluginOptions, options: PeertubePlayerManagerOptions) {
372 const commonOptions = options.common
373 const webtorrentOptions = options.webtorrent
375 const autoplay = this.getAutoPlayValue(commonOptions.autoplay) === 'play'
381 videoDuration: commonOptions.videoDuration,
382 playerElement: commonOptions.playerElement,
383 videoFiles: webtorrentOptions.videoFiles,
384 startTime: commonOptions.startTime
387 Object.assign(plugins, { webtorrent })
390 private static getControlBarChildren (mode: PlayerMode, options: {
391 peertubeLink: boolean
392 theaterButton: boolean
396 hasNextVideo?: () => boolean
398 previousVideo?: Function
399 hasPreviousVideo?: () => boolean
401 const settingEntries = []
402 const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
405 settingEntries.push('playbackRateMenuButton')
406 if (options.captions === true) settingEntries.push('captionsButton')
407 settingEntries.push('resolutionMenuButton')
411 if (options.previousVideo) {
412 const buttonOptions: NextPreviousVideoButtonOptions = {
414 handler: options.previousVideo,
416 if (!options.hasPreviousVideo) return false
418 return !options.hasPreviousVideo()
422 Object.assign(children, {
423 'previousVideoButton': buttonOptions
427 Object.assign(children, { playToggle: {} })
429 if (options.nextVideo) {
430 const buttonOptions: NextPreviousVideoButtonOptions = {
432 handler: options.nextVideo,
434 if (!options.hasNextVideo) return false
436 return !options.hasNextVideo()
440 Object.assign(children, {
441 'nextVideoButton': buttonOptions
445 Object.assign(children, {
446 'currentTimeDisplay': {},
448 'durationDisplay': {},
451 'flexibleWidthSpacer': {},
456 [loadProgressBar]: {},
457 'mouseTimeDisplay': {},
458 'playProgressBar': {}
473 entries: settingEntries
477 if (options.peertubeLink === true) {
478 Object.assign(children, {
479 'peerTubeLinkButton': {}
483 if (options.theaterButton === true) {
484 Object.assign(children, {
489 Object.assign(children, {
490 'fullscreenToggle': {}
496 private static addContextMenu (mode: PlayerMode, player: videojs.Player, videoEmbedUrl: string, videoEmbedTitle: string) {
499 label: player.localize('Copy the video URL'),
500 listener: function () {
501 copyToClipboard(buildVideoLink())
505 label: player.localize('Copy the video URL at the current time'),
506 listener: function (this: videojs.Player) {
507 copyToClipboard(buildVideoLink({ startTime: this.currentTime() }))
511 label: player.localize('Copy embed code'),
513 copyToClipboard(buildVideoOrPlaylistEmbed(videoEmbedUrl, videoEmbedTitle))
518 if (mode === 'webtorrent') {
520 label: player.localize('Copy magnet URI'),
521 listener: function (this: videojs.Player) {
522 copyToClipboard(this.webtorrent().getCurrentVideoFile().magnetUri)
527 player.contextmenuUI({ content })
530 private static addHotkeysOptions (plugins: VideoJSPluginOptions) {
531 const isNaked = (event: KeyboardEvent, key: string) =>
532 (!event.ctrlKey && !event.altKey && !event.metaKey && !event.shiftKey && event.key === key)
534 Object.assign(plugins, {
536 skipInitialFocus: true,
537 enableInactiveFocus: false,
538 captureDocumentHotkeys: true,
539 documentHotkeysFocusElementFilter: (e: HTMLElement) => {
540 const tagName = e.tagName.toLowerCase()
541 return e.id === 'content' || tagName === 'body' || tagName === 'video'
544 enableVolumeScroll: false,
545 enableModifiersForNumbers: false,
547 rewindKey: function (event: KeyboardEvent) {
548 return isNaked(event, 'ArrowLeft')
551 forwardKey: function (event: KeyboardEvent) {
552 return isNaked(event, 'ArrowRight')
555 fullscreenKey: function (event: KeyboardEvent) {
556 // fullscreen with the f key or Ctrl+Enter
557 return isNaked(event, 'f') || (!event.altKey && event.ctrlKey && event.key === 'Enter')
561 increasePlaybackRateKey: {
562 key: function (event: KeyboardEvent) {
563 return isNaked(event, '>')
565 handler: function (player: videojs.Player) {
566 const newValue = Math.min(player.playbackRate() + 0.1, 5)
567 player.playbackRate(parseFloat(newValue.toFixed(2)))
570 decreasePlaybackRateKey: {
571 key: function (event: KeyboardEvent) {
572 return isNaked(event, '<')
574 handler: function (player: videojs.Player) {
575 const newValue = Math.max(player.playbackRate() - 0.1, 0.10)
576 player.playbackRate(parseFloat(newValue.toFixed(2)))
580 key: function (event: KeyboardEvent) {
581 return isNaked(event, '.')
583 handler: function (player: videojs.Player) {
585 // Calculate movement distance (assuming 30 fps)
587 player.currentTime(player.currentTime() + dist)
595 private static getAutoPlayValue (autoplay: any) {
596 if (autoplay !== true) return autoplay
598 // On first play, disable autoplay to avoid issues
599 // But if the player already played videos, we can safely autoplay next ones
600 if (isIOS() || isSafari()) {
601 return PeertubePlayerManager.alreadyPlayed ? 'play' : false
608 // ############################################################################