-import { VideoFile } from '../../../../shared/models/videos'
-import videojs, { VideoJsPlayer, VideoJsPlayerOptions } from 'video.js'
-import 'videojs-hotkeys'
+import 'videojs-hotkeys/videojs.hotkeys'
import 'videojs-dock'
-import 'videojs-contextmenu-ui'
-import 'videojs-contrib-quality-levels'
+import '@peertube/videojs-contextmenu'
import './upnext/end-card'
import './upnext/upnext-plugin'
+import './stats/stats-card'
+import './stats/stats-plugin'
import './bezels/bezels-plugin'
import './peertube-plugin'
-import './videojs-components/next-video-button'
+import './peertube-resolutions-plugin'
+import './videojs-components/next-previous-video-button'
import './videojs-components/p2p-info-button'
import './videojs-components/peertube-link-button'
import './videojs-components/peertube-load-progress-bar'
import './videojs-components/settings-panel'
import './videojs-components/settings-panel-child'
import './videojs-components/theater-button'
-import { P2PMediaLoaderPluginOptions, UserWatching, VideoJSCaption, VideoJSPluginOptions } from './peertube-videojs-typings'
-import { buildVideoEmbed, buildVideoLink, copyToClipboard, getRtcConfig } from './utils'
-import { isDefaultLocale } from '../../../../shared/models/i18n/i18n'
-import { segmentValidatorFactory } from './p2p-media-loader/segment-validator'
-import { segmentUrlBuilderFactory } from './p2p-media-loader/segment-url-builder'
+import './playlist/playlist-plugin'
+import './mobile/peertube-mobile-plugin'
+import './mobile/peertube-mobile-buttons'
+import videojs from 'video.js'
+import { HlsJsEngineSettings } from '@peertube/p2p-media-loader-hlsjs'
+import { PluginsManager } from '@root-helpers/plugins-manager'
+import { buildVideoLink, decorateVideoLink } from '@shared/core-utils'
+import { isDefaultLocale } from '@shared/core-utils/i18n'
+import { VideoFile } from '@shared/models'
+import { copyToClipboard } from '../../root-helpers/utils'
import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager'
-import { getStoredP2PEnabled } from './peertube-player-local-storage'
+import { segmentUrlBuilderFactory } from './p2p-media-loader/segment-url-builder'
+import { segmentValidatorFactory } from './p2p-media-loader/segment-validator'
+import { getAverageBandwidthInStore, saveAverageBandwidth } from './peertube-player-local-storage'
+import {
+ NextPreviousVideoButtonOptions,
+ P2PMediaLoaderPluginOptions,
+ PeerTubeLinkButtonOptions,
+ PlayerNetworkInfo,
+ PlaylistPluginOptions,
+ UserWatching,
+ VideoJSCaption,
+ VideoJSPluginOptions
+} from './peertube-videojs-typings'
import { TranslationsManager } from './translations-manager'
-
-// For VideoJS
-(window as any).WebVTT = require('vtt.js/lib/vtt.js').WebVTT;
+import { buildVideoOrPlaylistEmbed, getRtcConfig, isIOS, isMobile, isSafari } from './utils'
// Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
(videojs.getComponent('PlaybackRateMenuButton') as any).prototype.controlText_ = 'Speed'
onPlayerElementChange: (element: HTMLVideoElement) => void
autoplay: boolean
- nextVideo?: Function
+ p2pEnabled: boolean
+
+ nextVideo?: () => void
+ hasNextVideo?: () => boolean
+
+ previousVideo?: () => void
+ hasPreviousVideo?: () => boolean
+
+ playlist?: PlaylistPluginOptions
+
videoDuration: number
enableHotkeys: boolean
inactivityTimeout: number
videoViewUrl: string
embedUrl: string
+ embedTitle: string
+
+ isLive: boolean
language?: string
videoCaptions: VideoJSCaption[]
+ videoUUID: string
+ videoShortUUID: string
+
userWatching?: UserWatching
serverUrl: string
}
export type PeertubePlayerManagerOptions = {
- common: CommonOptions,
- webtorrent: WebtorrentOptions,
+ common: CommonOptions
+ webtorrent: WebtorrentOptions
p2pMediaLoader?: P2PMediaLoaderOptions
+
+ pluginsManager: PluginsManager
}
export class PeertubePlayerManager {
private static playerElementClassName: string
- private static onPlayerChange: (player: VideoJsPlayer) => void
+ private static onPlayerChange: (player: videojs.Player) => void
+ private static alreadyPlayed = false
+ private static pluginsManager: PluginsManager
+
+ static initState () {
+ PeertubePlayerManager.alreadyPlayed = false
+ }
+
+ static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: videojs.Player) => void) {
+ this.pluginsManager = options.pluginsManager
- static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: VideoJsPlayer) => void) {
let p2pMediaLoader: any
this.onPlayerChange = onPlayerChange
if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
if (mode === 'p2p-media-loader') {
[ p2pMediaLoader ] = await Promise.all([
- import('p2p-media-loader-hlsjs'),
+ import('@peertube/p2p-media-loader-hlsjs'),
import('./p2p-media-loader/p2p-media-loader-plugin')
])
}
- const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader)
+ const videojsOptions = await this.getVideojsOptions(mode, options, p2pMediaLoader)
await TranslationsManager.loadLocaleInVideoJS(options.common.serverUrl, options.common.language, videojs)
const self = this
return new Promise(res => {
- videojs(options.common.playerElement, videojsOptions, function (this: VideoJsPlayer) {
+ videojs(options.common.playerElement, videojsOptions, function (this: videojs.Player) {
const player = this
let alreadyFallback = false
alreadyFallback = true
})
- self.addContextMenu(mode, player, options.common.embedUrl)
+ player.one('play', () => {
+ PeertubePlayerManager.alreadyPlayed = true
+ })
+
+ self.addContextMenu({
+ mode,
+ player,
+ videoShortUUID: options.common.videoShortUUID,
+ videoEmbedUrl: options.common.embedUrl,
+ videoEmbedTitle: options.common.embedTitle
+ })
+
+ if (isMobile()) player.peertubeMobile()
player.bezels()
+ player.stats({
+ videoUUID: options.common.videoUUID,
+ videoIsLive: options.common.isLive,
+ mode,
+ p2pEnabled: options.common.p2pEnabled
+ })
+
+ player.on('p2pInfo', (_, data: PlayerNetworkInfo) => {
+ if (data.source !== 'p2p-media-loader' || isNaN(data.bandwidthEstimate)) return
+
+ saveAverageBandwidth(data.bandwidthEstimate)
+ })
+
return res(player)
})
})
await import('./webtorrent/webtorrent-plugin')
const mode = 'webtorrent'
- const videojsOptions = this.getVideojsOptions(mode, options)
+ const videojsOptions = await this.getVideojsOptions(mode, options)
const self = this
- videojs(newVideoElement, videojsOptions, function (this: VideoJsPlayer) {
+ videojs(newVideoElement, videojsOptions, function (this: videojs.Player) {
const player = this
- self.addContextMenu(mode, player, options.common.embedUrl)
+ self.addContextMenu({
+ mode,
+ player,
+ videoShortUUID: options.common.videoShortUUID,
+ videoEmbedUrl: options.common.embedUrl,
+ videoEmbedTitle: options.common.embedTitle
+ })
PeertubePlayerManager.onPlayerChange(player)
})
}
- private static getVideojsOptions (
+ private static async getVideojsOptions (
mode: PlayerMode,
options: PeertubePlayerManagerOptions,
p2pMediaLoaderModule?: any
- ): VideoJsPlayerOptions {
+ ): Promise<videojs.PlayerOptions> {
const commonOptions = options.common
+ const isHLS = mode === 'p2p-media-loader'
- let autoplay = commonOptions.autoplay
- let html5 = {}
+ let autoplay = this.getAutoPlayValue(commonOptions.autoplay)
+ const html5 = {
+ preloadTextTracks: false
+ }
const plugins: VideoJSPluginOptions = {
peertube: {
mode,
- autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
+ autoplay, // Use peertube plugin autoplay because we could get the file by webtorrent
videoViewUrl: commonOptions.videoViewUrl,
videoDuration: commonOptions.videoDuration,
userWatching: commonOptions.userWatching,
subtitle: commonOptions.subtitle,
videoCaptions: commonOptions.videoCaptions,
- stopTime: commonOptions.stopTime
+ stopTime: commonOptions.stopTime,
+ isLive: commonOptions.isLive,
+ videoUUID: commonOptions.videoUUID
}
}
+ if (commonOptions.playlist) {
+ plugins.playlist = commonOptions.playlist
+ }
+
if (commonOptions.enableHotkeys === true) {
PeertubePlayerManager.addHotkeysOptions(plugins)
}
- if (mode === 'p2p-media-loader') {
- const { streamrootHls } = PeertubePlayerManager.addP2PMediaLoaderOptions(plugins, options, p2pMediaLoaderModule)
+ if (isHLS) {
+ const { hlsjs } = PeertubePlayerManager.addP2PMediaLoaderOptions(plugins, options, p2pMediaLoaderModule)
- html5 = streamrootHls.html5
+ Object.assign(html5, hlsjs.html5)
}
if (mode === 'webtorrent') {
? commonOptions.muted
: undefined, // Undefined so the player knows it has to check the local storage
- autoplay: autoplay === true
- ? 'any' // Use 'any' instead of true to get notifier by videojs if autoplay fails
- : autoplay,
+ autoplay: this.getAutoPlayValue(autoplay),
poster: commonOptions.poster,
inactivityTimeout: commonOptions.inactivityTimeout,
- playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
+ playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2 ],
plugins,
controlBar: {
children: this.getControlBarChildren(mode, {
+ videoShortUUID: commonOptions.videoShortUUID,
+ p2pEnabled: commonOptions.p2pEnabled,
+
captions: commonOptions.captions,
peertubeLink: commonOptions.peertubeLink,
theaterButton: commonOptions.theaterButton,
- nextVideo: commonOptions.nextVideo
+
+ nextVideo: commonOptions.nextVideo,
+ hasNextVideo: commonOptions.hasNextVideo,
+
+ previousVideo: commonOptions.previousVideo,
+ hasPreviousVideo: commonOptions.hasPreviousVideo
}) as any // FIXME: typings
}
}
Object.assign(videojsOptions, { language: commonOptions.language })
}
- return videojsOptions
+ return this.pluginsManager.runHook('filter:internal.player.videojs.options.result', videojsOptions)
}
private static addP2PMediaLoaderOptions (
}
let consumeOnly = false
- // FIXME: typings
- if (navigator && (navigator as any).connection && (navigator as any).connection.type === 'cellular') {
+ if ((navigator as any)?.connection?.type === 'cellular') {
console.log('We are on a cellular connection: disabling seeding.')
consumeOnly = true
}
- const p2pMediaLoaderConfig = {
+ const p2pMediaLoaderConfig: HlsJsEngineSettings = {
loader: {
trackerAnnounce,
- segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url),
+ segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url, options.common.isLive),
rtcConfig: getRtcConfig(),
- requiredSegmentsPriority: 5,
- segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager),
- useP2P: getStoredP2PEnabled(),
+ requiredSegmentsPriority: 1,
+ simultaneousHttpDownloads: 1,
+ segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager, 1),
+ useP2P: commonOptions.p2pEnabled,
consumeOnly
},
segments: {
swarmId: p2pMediaLoaderOptions.playlistUrl
}
}
- const streamrootHls = {
+
+ const hlsjs = {
levelLabelHandler: (level: { height: number, width: number }) => {
- const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === level.height)
+ const resolution = Math.min(level.height || 0, level.width || 0)
+
+ const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === resolution)
+ // We don't have files for live videos
+ if (!file) return level.height
let label = file.resolution.label
if (file.fps >= 50) label += file.fps
return label
},
html5: {
- hlsjsConfig: {
- capLevelToPlayerSize: true,
- autoStartLoad: false,
- liveSyncDurationCount: 7,
- loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
- }
+ hlsjsConfig: this.getHLSOptions(p2pMediaLoaderModule, p2pMediaLoaderConfig)
}
}
- const toAssign = { p2pMediaLoader, streamrootHls }
+ const toAssign = { p2pMediaLoader, hlsjs }
Object.assign(plugins, toAssign)
return toAssign
}
+ private static getHLSOptions (p2pMediaLoaderModule: any, p2pMediaLoaderConfig: HlsJsEngineSettings) {
+ const base = {
+ capLevelToPlayerSize: true,
+ autoStartLoad: false,
+ liveSyncDurationCount: 5,
+
+ loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
+ }
+
+ const averageBandwidth = getAverageBandwidthInStore()
+ if (!averageBandwidth) return base
+
+ return {
+ ...base,
+
+ abrEwmaDefaultEstimate: averageBandwidth * 8, // We want bit/s
+ startLevel: -1,
+ testBandwidth: false,
+ debug: false
+ }
+ }
+
private static addWebTorrentOptions (plugins: VideoJSPluginOptions, options: PeertubePlayerManagerOptions) {
const commonOptions = options.common
const webtorrentOptions = options.webtorrent
+ const p2pMediaLoaderOptions = options.p2pMediaLoader
+
+ const autoplay = this.getAutoPlayValue(commonOptions.autoplay) === 'play'
const webtorrent = {
- autoplay: commonOptions.autoplay,
+ autoplay,
+ playerRefusedP2P: commonOptions.p2pEnabled === false,
videoDuration: commonOptions.videoDuration,
playerElement: commonOptions.playerElement,
- videoFiles: webtorrentOptions.videoFiles,
+ videoFiles: webtorrentOptions.videoFiles.length !== 0
+ ? webtorrentOptions.videoFiles
+ // The WebTorrent plugin won't be able to play these files, but it will fallback to HTTP mode
+ : p2pMediaLoaderOptions?.videoFiles || [],
startTime: commonOptions.startTime
}
}
private static getControlBarChildren (mode: PlayerMode, options: {
+ p2pEnabled: boolean
+ videoShortUUID: string
+
peertubeLink: boolean
- theaterButton: boolean,
- captions: boolean,
- nextVideo?: Function
+ theaterButton: boolean
+ captions: boolean
+
+ nextVideo?: () => void
+ hasNextVideo?: () => boolean
+
+ previousVideo?: () => void
+ hasPreviousVideo?: () => boolean
}) {
const settingEntries = []
const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
if (options.captions === true) settingEntries.push('captionsButton')
settingEntries.push('resolutionMenuButton')
- const children = {
- 'playToggle': {}
+ const children = {}
+
+ if (options.previousVideo) {
+ const buttonOptions: NextPreviousVideoButtonOptions = {
+ type: 'previous',
+ handler: options.previousVideo,
+ isDisabled: () => {
+ if (!options.hasPreviousVideo) return false
+
+ return !options.hasPreviousVideo()
+ }
+ }
+
+ Object.assign(children, {
+ previousVideoButton: buttonOptions
+ })
}
+ Object.assign(children, { playToggle: {} })
+
if (options.nextVideo) {
- Object.assign(children, {
- 'nextVideoButton': {
- handler: options.nextVideo
+ const buttonOptions: NextPreviousVideoButtonOptions = {
+ type: 'next',
+ handler: options.nextVideo,
+ isDisabled: () => {
+ if (!options.hasNextVideo) return false
+
+ return !options.hasNextVideo()
}
+ }
+
+ Object.assign(children, {
+ nextVideoButton: buttonOptions
})
}
Object.assign(children, {
- 'currentTimeDisplay': {},
- 'timeDivider': {},
- 'durationDisplay': {},
- 'liveDisplay': {},
+ currentTimeDisplay: {},
+ timeDivider: {},
+ durationDisplay: {},
+ liveDisplay: {},
- 'flexibleWidthSpacer': {},
- 'progressControl': {
+ flexibleWidthSpacer: {},
+ progressControl: {
children: {
- 'seekBar': {
+ seekBar: {
children: {
[loadProgressBar]: {},
- 'mouseTimeDisplay': {},
- 'playProgressBar': {}
+ mouseTimeDisplay: {},
+ playProgressBar: {}
}
}
}
},
- 'p2PInfoButton': {},
+ p2PInfoButton: {
+ p2pEnabled: options.p2pEnabled
+ },
- 'muteToggle': {},
- 'volumeControl': {},
+ muteToggle: {},
+ volumeControl: {},
- 'settingsButton': {
+ settingsButton: {
setup: {
maxHeightOffset: 40
},
if (options.peertubeLink === true) {
Object.assign(children, {
- 'peerTubeLinkButton': {}
+ peerTubeLinkButton: { shortUUID: options.videoShortUUID } as PeerTubeLinkButtonOptions
})
}
if (options.theaterButton === true) {
Object.assign(children, {
- 'theaterButton': {}
+ theaterButton: {}
})
}
Object.assign(children, {
- 'fullscreenToggle': {}
+ fullscreenToggle: {}
})
return children
}
- private static addContextMenu (mode: PlayerMode, player: VideoJsPlayer, 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 (this: VideoJsPlayer) {
- copyToClipboard(buildVideoLink({ startTime: this.currentTime() }))
- }
- },
- {
- label: player.localize('Copy embed code'),
- listener: () => {
- copyToClipboard(buildVideoEmbed(videoEmbedUrl))
+ private static addContextMenu (options: {
+ mode: PlayerMode
+ player: videojs.Player
+ videoShortUUID: string
+ videoEmbedUrl: string
+ videoEmbedTitle: string
+ }) {
+ const { mode, player, videoEmbedTitle, videoEmbedUrl, videoShortUUID } = options
+
+ const content = () => {
+ const isLoopEnabled = player.options_['loop']
+ const items = [
+ {
+ icon: 'repeat',
+ label: player.localize('Play in loop') + (isLoopEnabled ? '<span class="vjs-icon-tick-white"></span>' : ''),
+ listener: function () {
+ player.options_['loop'] = !isLoopEnabled
+ }
+ },
+ {
+ label: player.localize('Copy the video URL'),
+ listener: function () {
+ copyToClipboard(buildVideoLink({ shortUUID: videoShortUUID }))
+ }
+ },
+ {
+ label: player.localize('Copy the video URL at the current time'),
+ listener: function (this: videojs.Player) {
+ const url = buildVideoLink({ shortUUID: videoShortUUID })
+
+ copyToClipboard(decorateVideoLink({ url, startTime: this.currentTime() }))
+ }
+ },
+ {
+ icon: 'code',
+ label: player.localize('Copy embed code'),
+ listener: () => {
+ copyToClipboard(buildVideoOrPlaylistEmbed(videoEmbedUrl, videoEmbedTitle))
+ }
}
+ ]
+
+ if (mode === 'webtorrent') {
+ items.push({
+ label: player.localize('Copy magnet URI'),
+ listener: function (this: videojs.Player) {
+ copyToClipboard(this.webtorrent().getCurrentVideoFile().magnetUri)
+ }
+ })
}
- ]
- if (mode === 'webtorrent') {
- content.push({
- label: player.localize('Copy magnet URI'),
- listener: function (this: VideoJsPlayer) {
- copyToClipboard(this.webtorrent().getCurrentVideoFile().magnetUri)
+ items.push({
+ icon: 'info',
+ label: player.localize('Stats for nerds'),
+ listener: () => {
+ player.stats().show()
}
})
+
+ return items.map(i => ({
+ ...i,
+ label: `<span class="vjs-icon-${i.icon || 'link-2'}"></span>` + i.label
+ }))
}
+ // adding the menu
player.contextmenuUI({ content })
}
private static addHotkeysOptions (plugins: VideoJSPluginOptions) {
+ const isNaked = (event: KeyboardEvent, key: string) =>
+ (!event.ctrlKey && !event.altKey && !event.metaKey && !event.shiftKey && event.key === key)
+
Object.assign(plugins, {
hotkeys: {
+ skipInitialFocus: true,
+ enableInactiveFocus: false,
+ captureDocumentHotkeys: true,
+ documentHotkeysFocusElementFilter: (e: HTMLElement) => {
+ const tagName = e.tagName.toLowerCase()
+ return e.id === 'content' || tagName === 'body' || tagName === 'video'
+ },
+
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')
+ rewindKey: function (event: KeyboardEvent) {
+ return isNaked(event, 'ArrowLeft')
},
- 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
- }
+ forwardKey: function (event: KeyboardEvent) {
+ return isNaked(event, 'ArrowRight')
+ },
+
+ fullscreenKey: function (event: KeyboardEvent) {
+ // fullscreen with the f key or Ctrl+Enter
+ return isNaked(event, 'f') || (!event.altKey && event.ctrlKey && event.key === 'Enter')
},
customKeys: {
increasePlaybackRateKey: {
key: function (event: KeyboardEvent) {
- return event.key === '>'
+ return isNaked(event, '>')
},
handler: function (player: videojs.Player) {
const newValue = Math.min(player.playbackRate() + 0.1, 5)
},
decreasePlaybackRateKey: {
key: function (event: KeyboardEvent) {
- return event.key === '<'
+ return isNaked(event, '<')
},
handler: function (player: videojs.Player) {
const newValue = Math.max(player.playbackRate() - 0.1, 0.10)
player.playbackRate(parseFloat(newValue.toFixed(2)))
}
},
- frameByFrame: {
+ previousFrame: {
+ 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)
+ }
+ },
+ nextFrame: {
key: function (event: KeyboardEvent) {
return event.key === '.'
},
}
})
}
+
+ private static getAutoPlayValue (autoplay: any) {
+ if (autoplay !== true) return autoplay
+
+ // On first play, disable autoplay to avoid issues
+ // But if the player already played videos, we can safely autoplay next ones
+ if (isIOS() || isSafari()) {
+ return PeertubePlayerManager.alreadyPlayed ? 'play' : false
+ }
+
+ return 'play'
+ }
}
// ############################################################################