1 import { VideoFile } from '../../../../shared/models/videos'
3 import * as videojs from 'video.js'
4 import 'videojs-hotkeys'
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'
22 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
23 videojsUntyped.getComponent('PlaybackRateMenuButton').prototype.controlText_ = 'Speed'
24 // Change Captions to Subtitles/CC
25 videojsUntyped.getComponent('CaptionsButton').prototype.controlText_ = 'Subtitles/CC'
26 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
27 videojsUntyped.getComponent('CaptionsButton').prototype.label_ = ' '
29 export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
31 export type WebtorrentOptions = {
32 videoFiles: VideoFile[]
35 export type P2PMediaLoaderOptions = {
37 segmentsSha256Url: string
38 trackerAnnounce: string[]
39 redundancyBaseUrls: string[]
40 videoFiles: VideoFile[]
43 export interface CustomizationOptions {
44 startTime: number | string
45 stopTime: number | string
55 export interface CommonOptions extends CustomizationOptions {
56 playerElement: HTMLVideoElement
57 onPlayerElementChange: (element: HTMLVideoElement) => void
61 enableHotkeys: boolean
62 inactivityTimeout: number
73 videoCaptions: VideoJSCaption[]
75 userWatching?: UserWatching
80 export type PeertubePlayerManagerOptions = {
81 common: CommonOptions,
82 webtorrent: WebtorrentOptions,
83 p2pMediaLoader?: P2PMediaLoaderOptions
86 export class PeertubePlayerManager {
88 private static videojsLocaleCache: { [ path: string ]: any } = {}
89 private static playerElementClassName: string
90 private static onPlayerChange: (player: any) => void
92 static getServerTranslations (serverUrl: string, locale: string) {
93 const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
94 // It is the default locale, nothing to translate
95 if (!path) return Promise.resolve(undefined)
97 return fetch(path + '/server.json')
98 .then(res => res.json())
100 console.error('Cannot get server translations', err)
105 static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: any) => void) {
106 let p2pMediaLoader: any
108 this.onPlayerChange = onPlayerChange
109 this.playerElementClassName = options.common.playerElement.className
111 if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
112 if (mode === 'p2p-media-loader') {
113 [ p2pMediaLoader ] = await Promise.all([
114 import('p2p-media-loader-hlsjs'),
115 import('./p2p-media-loader/p2p-media-loader-plugin')
119 const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader)
121 await this.loadLocaleInVideoJS(options.common.serverUrl, options.common.language)
124 return new Promise(res => {
125 videojs(options.common.playerElement, videojsOptions, function (this: any) {
128 let alreadyFallback = false
130 player.tech_.one('error', () => {
131 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
132 alreadyFallback = true
135 player.one('error', () => {
136 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
137 alreadyFallback = true
140 self.addContextMenu(mode, player, options.common.embedUrl)
147 private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) {
148 if (currentMode === 'webtorrent') return
150 console.log('Fallback to webtorrent.')
152 const newVideoElement = document.createElement('video')
153 newVideoElement.className = this.playerElementClassName
155 // VideoJS wraps our video element inside a div
156 let currentParentPlayerElement = options.common.playerElement.parentNode
157 // Fix on IOS, don't ask me why
158 if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(options.common.playerElement.id).parentNode
160 currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
162 options.common.playerElement = newVideoElement
163 options.common.onPlayerElementChange(newVideoElement)
167 await import('./webtorrent/webtorrent-plugin')
169 const mode = 'webtorrent'
170 const videojsOptions = this.getVideojsOptions(mode, options)
173 videojs(newVideoElement, videojsOptions, function (this: any) {
176 self.addContextMenu(mode, player, options.common.embedUrl)
178 PeertubePlayerManager.onPlayerChange(player)
182 private static loadLocaleInVideoJS (serverUrl: string, locale: string) {
183 const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
184 // It is the default locale, nothing to translate
185 if (!path) return Promise.resolve(undefined)
189 if (PeertubePlayerManager.videojsLocaleCache[path]) {
190 p = Promise.resolve(PeertubePlayerManager.videojsLocaleCache[path])
192 p = fetch(path + '/player.json')
193 .then(res => res.json())
195 PeertubePlayerManager.videojsLocaleCache[path] = json
199 console.error('Cannot get player translations', err)
204 const completeLocale = getCompleteLocale(locale)
205 return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json))
208 private static getVideojsOptions (mode: PlayerMode, options: PeertubePlayerManagerOptions, p2pMediaLoaderModule?: any) {
209 const commonOptions = options.common
210 const webtorrentOptions = options.webtorrent
211 const p2pMediaLoaderOptions = options.p2pMediaLoader
213 let autoplay = options.common.autoplay
216 const plugins: VideoJSPluginOptions = {
219 autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
220 videoViewUrl: commonOptions.videoViewUrl,
221 videoDuration: commonOptions.videoDuration,
222 userWatching: commonOptions.userWatching,
223 subtitle: commonOptions.subtitle,
224 videoCaptions: commonOptions.videoCaptions,
225 stopTime: commonOptions.stopTime
229 if (mode === 'p2p-media-loader') {
230 const redundancyUrlManager = new RedundancyUrlManager(options.p2pMediaLoader.redundancyBaseUrls)
232 const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
233 redundancyUrlManager,
234 type: 'application/x-mpegURL',
235 startTime: commonOptions.startTime,
236 src: p2pMediaLoaderOptions.playlistUrl
239 const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce
240 .filter(t => t.startsWith('ws'))
242 const p2pMediaLoaderConfig = {
245 segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url),
246 rtcConfig: getRtcConfig(),
247 requiredSegmentsPriority: 5,
248 segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager)
251 swarmId: p2pMediaLoaderOptions.playlistUrl
254 const streamrootHls = {
255 levelLabelHandler: (level: { height: number, width: number }) => {
256 const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === level.height)
258 let label = file.resolution.label
259 if (file.fps >= 50) label += file.fps
265 autoStartLoad: false,
266 liveSyncDurationCount: 7,
267 loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
272 Object.assign(plugins, { p2pMediaLoader, streamrootHls })
273 html5 = streamrootHls.html5
276 if (mode === 'webtorrent') {
279 videoDuration: commonOptions.videoDuration,
280 playerElement: commonOptions.playerElement,
281 videoFiles: webtorrentOptions.videoFiles,
282 startTime: commonOptions.startTime
284 Object.assign(plugins, { webtorrent })
286 // WebTorrent plugin handles autoplay, because we do some hackish stuff in there
290 const videojsOptions = {
293 // We don't use text track settings for now
294 textTrackSettings: false,
295 controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
296 loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
298 muted: commonOptions.muted !== undefined
299 ? commonOptions.muted
300 : undefined, // Undefined so the player knows it has to check the local storage
302 poster: commonOptions.poster,
303 autoplay: autoplay === true ? 'any' : autoplay, // Use 'any' instead of true to get notifier by videojs if autoplay fails
304 inactivityTimeout: commonOptions.inactivityTimeout,
305 playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
308 children: this.getControlBarChildren(mode, {
309 captions: commonOptions.captions,
310 peertubeLink: commonOptions.peertubeLink,
311 theaterMode: commonOptions.theaterMode
316 if (commonOptions.enableHotkeys === true) {
317 Object.assign(videojsOptions.plugins, {
319 enableVolumeScroll: false,
320 enableModifiersForNumbers: false,
322 fullscreenKey: function (event: KeyboardEvent) {
323 // fullscreen with the f key or Ctrl+Enter
324 return event.key === 'f' || (event.ctrlKey && event.key === 'Enter')
327 seekStep: function (event: KeyboardEvent) {
328 // mimic VLC seek behavior, and default to 5 (original value is 5).
329 if (event.ctrlKey && event.altKey) {
331 } else if (event.ctrlKey) {
333 } else if (event.altKey) {
341 increasePlaybackRateKey: {
342 key: function (event: KeyboardEvent) {
343 return event.key === '>'
345 handler: function (player: videojs.Player) {
346 player.playbackRate((player.playbackRate() + 0.1).toFixed(2))
349 decreasePlaybackRateKey: {
350 key: function (event: KeyboardEvent) {
351 return event.key === '<'
353 handler: function (player: videojs.Player) {
354 player.playbackRate((player.playbackRate() - 0.1).toFixed(2))
358 key: function (event: KeyboardEvent) {
359 return event.key === '.'
361 handler: function (player: videojs.Player) {
363 // Calculate movement distance (assuming 30 fps)
365 player.currentTime(player.currentTime() + dist)
373 if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
374 Object.assign(videojsOptions, { language: commonOptions.language })
377 return videojsOptions
380 private static getControlBarChildren (mode: PlayerMode, options: {
381 peertubeLink: boolean
382 theaterMode: boolean,
385 const settingEntries = []
386 const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
389 settingEntries.push('playbackRateMenuButton')
390 if (options.captions === true) settingEntries.push('captionsButton')
391 settingEntries.push('resolutionMenuButton')
395 'currentTimeDisplay': {},
397 'durationDisplay': {},
400 'flexibleWidthSpacer': {},
405 [loadProgressBar]: {},
406 'mouseTimeDisplay': {},
407 'playProgressBar': {}
422 entries: settingEntries
426 if (options.peertubeLink === true) {
427 Object.assign(children, {
428 'peerTubeLinkButton': {}
432 if (options.theaterMode === true) {
433 Object.assign(children, {
438 Object.assign(children, {
439 'fullscreenToggle': {}
445 private static addContextMenu (mode: PlayerMode, player: any, videoEmbedUrl: string) {
448 label: player.localize('Copy the video URL'),
449 listener: function () {
450 copyToClipboard(buildVideoLink())
454 label: player.localize('Copy the video URL at the current time'),
455 listener: function () {
456 const player = this as videojs.Player
457 copyToClipboard(buildVideoLink({ startTime: player.currentTime() }))
461 label: player.localize('Copy embed code'),
463 copyToClipboard(buildVideoEmbed(videoEmbedUrl))
468 if (mode === 'webtorrent') {
470 label: player.localize('Copy magnet URI'),
471 listener: function () {
472 const player = this as videojs.Player
473 copyToClipboard(player.webtorrent().getCurrentVideoFile().magnetUri)
478 player.contextmenuUI({ content })
481 private static getLocalePath (serverUrl: string, locale: string) {
482 const completeLocale = getCompleteLocale(locale)
484 if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined
486 return serverUrl + '/client/locales/' + completeLocale
490 // ############################################################################