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'
21 import { getStoredP2PEnabled } from './peertube-player-local-storage'
23 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
24 videojsUntyped.getComponent('PlaybackRateMenuButton').prototype.controlText_ = 'Speed'
25 // Change Captions to Subtitles/CC
26 videojsUntyped.getComponent('CaptionsButton').prototype.controlText_ = 'Subtitles/CC'
27 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
28 videojsUntyped.getComponent('CaptionsButton').prototype.label_ = ' '
30 export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
32 export type WebtorrentOptions = {
33 videoFiles: VideoFile[]
36 export type P2PMediaLoaderOptions = {
38 segmentsSha256Url: string
39 trackerAnnounce: string[]
40 redundancyBaseUrls: string[]
41 videoFiles: VideoFile[]
44 export interface CustomizationOptions {
45 startTime: number | string
46 stopTime: number | string
56 export interface CommonOptions extends CustomizationOptions {
57 playerElement: HTMLVideoElement
58 onPlayerElementChange: (element: HTMLVideoElement) => void
62 enableHotkeys: boolean
63 inactivityTimeout: number
74 videoCaptions: VideoJSCaption[]
76 userWatching?: UserWatching
81 export type PeertubePlayerManagerOptions = {
82 common: CommonOptions,
83 webtorrent: WebtorrentOptions,
84 p2pMediaLoader?: P2PMediaLoaderOptions
87 export class PeertubePlayerManager {
89 private static videojsLocaleCache: { [ path: string ]: any } = {}
90 private static playerElementClassName: string
91 private static onPlayerChange: (player: any) => void
93 static getServerTranslations (serverUrl: string, locale: string) {
94 const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
95 // It is the default locale, nothing to translate
96 if (!path) return Promise.resolve(undefined)
98 return fetch(path + '/server.json')
99 .then(res => res.json())
101 console.error('Cannot get server translations', err)
106 static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: any) => void) {
107 let p2pMediaLoader: any
109 this.onPlayerChange = onPlayerChange
110 this.playerElementClassName = options.common.playerElement.className
112 if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
113 if (mode === 'p2p-media-loader') {
114 [ p2pMediaLoader ] = await Promise.all([
115 import('p2p-media-loader-hlsjs'),
116 import('./p2p-media-loader/p2p-media-loader-plugin')
120 const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader)
122 await this.loadLocaleInVideoJS(options.common.serverUrl, options.common.language)
125 return new Promise(res => {
126 videojs(options.common.playerElement, videojsOptions, function (this: any) {
129 let alreadyFallback = false
131 player.tech_.one('error', () => {
132 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
133 alreadyFallback = true
136 player.one('error', () => {
137 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
138 alreadyFallback = true
141 self.addContextMenu(mode, player, options.common.embedUrl)
148 private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) {
149 if (currentMode === 'webtorrent') return
151 console.log('Fallback to webtorrent.')
153 const newVideoElement = document.createElement('video')
154 newVideoElement.className = this.playerElementClassName
156 // VideoJS wraps our video element inside a div
157 let currentParentPlayerElement = options.common.playerElement.parentNode
158 // Fix on IOS, don't ask me why
159 if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(options.common.playerElement.id).parentNode
161 currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
163 options.common.playerElement = newVideoElement
164 options.common.onPlayerElementChange(newVideoElement)
168 await import('./webtorrent/webtorrent-plugin')
170 const mode = 'webtorrent'
171 const videojsOptions = this.getVideojsOptions(mode, options)
174 videojs(newVideoElement, videojsOptions, function (this: any) {
177 self.addContextMenu(mode, player, options.common.embedUrl)
179 PeertubePlayerManager.onPlayerChange(player)
183 private static loadLocaleInVideoJS (serverUrl: string, locale: string) {
184 const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
185 // It is the default locale, nothing to translate
186 if (!path) return Promise.resolve(undefined)
190 if (PeertubePlayerManager.videojsLocaleCache[path]) {
191 p = Promise.resolve(PeertubePlayerManager.videojsLocaleCache[path])
193 p = fetch(path + '/player.json')
194 .then(res => res.json())
196 PeertubePlayerManager.videojsLocaleCache[path] = json
200 console.error('Cannot get player translations', err)
205 const completeLocale = getCompleteLocale(locale)
206 return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json))
209 private static getVideojsOptions (mode: PlayerMode, options: PeertubePlayerManagerOptions, p2pMediaLoaderModule?: any) {
210 const commonOptions = options.common
211 const webtorrentOptions = options.webtorrent
212 const p2pMediaLoaderOptions = options.p2pMediaLoader
214 let autoplay = options.common.autoplay
217 const plugins: VideoJSPluginOptions = {
220 autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
221 videoViewUrl: commonOptions.videoViewUrl,
222 videoDuration: commonOptions.videoDuration,
223 userWatching: commonOptions.userWatching,
224 subtitle: commonOptions.subtitle,
225 videoCaptions: commonOptions.videoCaptions,
226 stopTime: commonOptions.stopTime
230 if (mode === 'p2p-media-loader') {
231 const redundancyUrlManager = new RedundancyUrlManager(options.p2pMediaLoader.redundancyBaseUrls)
233 const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
234 redundancyUrlManager,
235 type: 'application/x-mpegURL',
236 startTime: commonOptions.startTime,
237 src: p2pMediaLoaderOptions.playlistUrl
240 const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce
241 .filter(t => t.startsWith('ws'))
243 const p2pMediaLoaderConfig = {
246 segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url),
247 rtcConfig: getRtcConfig(),
248 requiredSegmentsPriority: 5,
249 segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager),
250 useP2P: getStoredP2PEnabled()
253 swarmId: p2pMediaLoaderOptions.playlistUrl
256 const streamrootHls = {
257 levelLabelHandler: (level: { height: number, width: number }) => {
258 const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === level.height)
260 let label = file.resolution.label
261 if (file.fps >= 50) label += file.fps
267 capLevelToPlayerSize: true,
268 autoStartLoad: false,
269 liveSyncDurationCount: 7,
270 loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
275 Object.assign(plugins, { p2pMediaLoader, streamrootHls })
276 html5 = streamrootHls.html5
279 if (mode === 'webtorrent') {
282 videoDuration: commonOptions.videoDuration,
283 playerElement: commonOptions.playerElement,
284 videoFiles: webtorrentOptions.videoFiles,
285 startTime: commonOptions.startTime
287 Object.assign(plugins, { webtorrent })
289 // WebTorrent plugin handles autoplay, because we do some hackish stuff in there
293 const videojsOptions = {
296 // We don't use text track settings for now
297 textTrackSettings: false,
298 controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
299 loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
301 muted: commonOptions.muted !== undefined
302 ? commonOptions.muted
303 : undefined, // Undefined so the player knows it has to check the local storage
305 poster: commonOptions.poster,
306 autoplay: autoplay === true ? 'any' : autoplay, // Use 'any' instead of true to get notifier by videojs if autoplay fails
307 inactivityTimeout: commonOptions.inactivityTimeout,
308 playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
311 children: this.getControlBarChildren(mode, {
312 captions: commonOptions.captions,
313 peertubeLink: commonOptions.peertubeLink,
314 theaterMode: commonOptions.theaterMode
319 if (commonOptions.enableHotkeys === true) {
320 Object.assign(videojsOptions.plugins, {
322 enableVolumeScroll: false,
323 enableModifiersForNumbers: false,
325 fullscreenKey: function (event: KeyboardEvent) {
326 // fullscreen with the f key or Ctrl+Enter
327 return event.key === 'f' || (event.ctrlKey && event.key === 'Enter')
330 seekStep: function (event: KeyboardEvent) {
331 // mimic VLC seek behavior, and default to 5 (original value is 5).
332 if (event.ctrlKey && event.altKey) {
334 } else if (event.ctrlKey) {
336 } else if (event.altKey) {
344 increasePlaybackRateKey: {
345 key: function (event: KeyboardEvent) {
346 return event.key === '>'
348 handler: function (player: videojs.Player) {
349 player.playbackRate((player.playbackRate() + 0.1).toFixed(2))
352 decreasePlaybackRateKey: {
353 key: function (event: KeyboardEvent) {
354 return event.key === '<'
356 handler: function (player: videojs.Player) {
357 player.playbackRate((player.playbackRate() - 0.1).toFixed(2))
361 key: function (event: KeyboardEvent) {
362 return event.key === '.'
364 handler: function (player: videojs.Player) {
366 // Calculate movement distance (assuming 30 fps)
368 player.currentTime(player.currentTime() + dist)
376 if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
377 Object.assign(videojsOptions, { language: commonOptions.language })
380 return videojsOptions
383 private static getControlBarChildren (mode: PlayerMode, options: {
384 peertubeLink: boolean
385 theaterMode: boolean,
388 const settingEntries = []
389 const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
392 settingEntries.push('playbackRateMenuButton')
393 if (options.captions === true) settingEntries.push('captionsButton')
394 settingEntries.push('resolutionMenuButton')
398 'currentTimeDisplay': {},
400 'durationDisplay': {},
403 'flexibleWidthSpacer': {},
408 [loadProgressBar]: {},
409 'mouseTimeDisplay': {},
410 'playProgressBar': {}
425 entries: settingEntries
429 if (options.peertubeLink === true) {
430 Object.assign(children, {
431 'peerTubeLinkButton': {}
435 if (options.theaterMode === true) {
436 Object.assign(children, {
441 Object.assign(children, {
442 'fullscreenToggle': {}
448 private static addContextMenu (mode: PlayerMode, player: any, videoEmbedUrl: string) {
451 label: player.localize('Copy the video URL'),
452 listener: function () {
453 copyToClipboard(buildVideoLink())
457 label: player.localize('Copy the video URL at the current time'),
458 listener: function () {
459 const player = this as videojs.Player
460 copyToClipboard(buildVideoLink({ startTime: player.currentTime() }))
464 label: player.localize('Copy embed code'),
466 copyToClipboard(buildVideoEmbed(videoEmbedUrl))
471 if (mode === 'webtorrent') {
473 label: player.localize('Copy magnet URI'),
474 listener: function () {
475 const player = this as videojs.Player
476 copyToClipboard(player.webtorrent().getCurrentVideoFile().magnetUri)
481 player.contextmenuUI({ content })
484 private static getLocalePath (serverUrl: string, locale: string) {
485 const completeLocale = getCompleteLocale(locale)
487 if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined
489 return serverUrl + '/client/locales/' + completeLocale
493 // ############################################################################