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'
21 // Change 'Playback Rate' to 'Speed' (smaller for our settings menu)
22 videojsUntyped.getComponent('PlaybackRateMenuButton').prototype.controlText_ = 'Speed'
23 // Change Captions to Subtitles/CC
24 videojsUntyped.getComponent('CaptionsButton').prototype.controlText_ = 'Subtitles/CC'
25 // We just want to display 'Off' instead of 'captions off', keep a space so the variable == true (hacky I know)
26 videojsUntyped.getComponent('CaptionsButton').prototype.label_ = ' '
28 export type PlayerMode = 'webtorrent' | 'p2p-media-loader'
30 export type WebtorrentOptions = {
31 videoFiles: VideoFile[]
34 export type P2PMediaLoaderOptions = {
36 segmentsSha256Url: string
37 trackerAnnounce: string[]
38 redundancyBaseUrls: string[]
39 videoFiles: VideoFile[]
42 export interface CustomizationOptions {
43 startTime: number | string
44 stopTime: number | string
54 export interface CommonOptions extends CustomizationOptions {
55 playerElement: HTMLVideoElement
56 onPlayerElementChange: (element: HTMLVideoElement) => void
60 enableHotkeys: boolean
61 inactivityTimeout: number
72 videoCaptions: VideoJSCaption[]
74 userWatching?: UserWatching
79 export type PeertubePlayerManagerOptions = {
80 common: CommonOptions,
81 webtorrent: WebtorrentOptions,
82 p2pMediaLoader?: P2PMediaLoaderOptions
85 export class PeertubePlayerManager {
87 private static videojsLocaleCache: { [ path: string ]: any } = {}
88 private static playerElementClassName: string
90 static getServerTranslations (serverUrl: string, locale: string) {
91 const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
92 // It is the default locale, nothing to translate
93 if (!path) return Promise.resolve(undefined)
95 return fetch(path + '/server.json')
96 .then(res => res.json())
98 console.error('Cannot get server translations', err)
103 static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions) {
104 let p2pMediaLoader: any
106 this.playerElementClassName = options.common.playerElement.className
108 if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin')
109 if (mode === 'p2p-media-loader') {
110 [ p2pMediaLoader ] = await Promise.all([
111 import('p2p-media-loader-hlsjs'),
112 import('./p2p-media-loader/p2p-media-loader-plugin')
116 const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader)
118 await this.loadLocaleInVideoJS(options.common.serverUrl, options.common.language)
121 return new Promise(res => {
122 videojs(options.common.playerElement, videojsOptions, function (this: any) {
125 let alreadyFallback = false
127 player.tech_.one('error', () => {
128 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
129 alreadyFallback = true
132 player.one('error', () => {
133 if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options)
134 alreadyFallback = true
137 self.addContextMenu(mode, player, options.common.embedUrl)
144 private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) {
145 if (currentMode === 'webtorrent') return
147 console.log('Fallback to webtorrent.')
149 const newVideoElement = document.createElement('video')
150 newVideoElement.className = this.playerElementClassName
152 // VideoJS wraps our video element inside a div
153 let currentParentPlayerElement = options.common.playerElement.parentNode
154 // Fix on IOS, don't ask me why
155 if (!currentParentPlayerElement) currentParentPlayerElement = document.getElementById(options.common.playerElement.id).parentNode
157 currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement)
159 options.common.playerElement = newVideoElement
160 options.common.onPlayerElementChange(newVideoElement)
164 await import('./webtorrent/webtorrent-plugin')
166 const mode = 'webtorrent'
167 const videojsOptions = this.getVideojsOptions(mode, options)
170 videojs(newVideoElement, videojsOptions, function (this: any) {
173 self.addContextMenu(mode, player, options.common.embedUrl)
177 private static loadLocaleInVideoJS (serverUrl: string, locale: string) {
178 const path = PeertubePlayerManager.getLocalePath(serverUrl, locale)
179 // It is the default locale, nothing to translate
180 if (!path) return Promise.resolve(undefined)
184 if (PeertubePlayerManager.videojsLocaleCache[path]) {
185 p = Promise.resolve(PeertubePlayerManager.videojsLocaleCache[path])
187 p = fetch(path + '/player.json')
188 .then(res => res.json())
190 PeertubePlayerManager.videojsLocaleCache[path] = json
194 console.error('Cannot get player translations', err)
199 const completeLocale = getCompleteLocale(locale)
200 return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json))
203 private static getVideojsOptions (mode: PlayerMode, options: PeertubePlayerManagerOptions, p2pMediaLoaderModule?: any) {
204 const commonOptions = options.common
205 const webtorrentOptions = options.webtorrent
206 const p2pMediaLoaderOptions = options.p2pMediaLoader
208 let autoplay = options.common.autoplay
211 const plugins: VideoJSPluginOptions = {
214 autoplay, // Use peertube plugin autoplay because we get the file by webtorrent
215 videoViewUrl: commonOptions.videoViewUrl,
216 videoDuration: commonOptions.videoDuration,
217 userWatching: commonOptions.userWatching,
218 subtitle: commonOptions.subtitle,
219 videoCaptions: commonOptions.videoCaptions,
220 stopTime: commonOptions.stopTime
224 if (mode === 'p2p-media-loader') {
225 const p2pMediaLoader: P2PMediaLoaderPluginOptions = {
226 redundancyBaseUrls: options.p2pMediaLoader.redundancyBaseUrls,
227 type: 'application/x-mpegURL',
228 startTime: commonOptions.startTime,
229 src: p2pMediaLoaderOptions.playlistUrl
232 const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce
233 .filter(t => t.startsWith('ws'))
235 const p2pMediaLoaderConfig = {
238 segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url),
239 rtcConfig: getRtcConfig(),
240 requiredSegmentsPriority: 5,
241 segmentUrlBuilder: segmentUrlBuilderFactory(options.p2pMediaLoader.redundancyBaseUrls)
244 swarmId: p2pMediaLoaderOptions.playlistUrl
247 const streamrootHls = {
248 levelLabelHandler: (level: { height: number, width: number }) => {
249 const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === level.height)
251 let label = file.resolution.label
252 if (file.fps >= 50) label += file.fps
258 liveSyncDurationCount: 7,
259 loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass()
264 Object.assign(plugins, { p2pMediaLoader, streamrootHls })
265 html5 = streamrootHls.html5
268 if (mode === 'webtorrent') {
271 videoDuration: commonOptions.videoDuration,
272 playerElement: commonOptions.playerElement,
273 videoFiles: webtorrentOptions.videoFiles,
274 startTime: commonOptions.startTime
276 Object.assign(plugins, { webtorrent })
278 // WebTorrent plugin handles autoplay, because we do some hackish stuff in there
282 const videojsOptions = {
285 // We don't use text track settings for now
286 textTrackSettings: false,
287 controls: commonOptions.controls !== undefined ? commonOptions.controls : true,
288 loop: commonOptions.loop !== undefined ? commonOptions.loop : false,
290 muted: commonOptions.muted !== undefined
291 ? commonOptions.muted
292 : undefined, // Undefined so the player knows it has to check the local storage
294 poster: commonOptions.poster,
295 autoplay: autoplay === true ? 'any' : autoplay, // Use 'any' instead of true to get notifier by videojs if autoplay fails
296 inactivityTimeout: commonOptions.inactivityTimeout,
297 playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ],
300 children: this.getControlBarChildren(mode, {
301 captions: commonOptions.captions,
302 peertubeLink: commonOptions.peertubeLink,
303 theaterMode: commonOptions.theaterMode
308 if (commonOptions.enableHotkeys === true) {
309 Object.assign(videojsOptions.plugins, {
311 enableVolumeScroll: false,
312 enableModifiersForNumbers: false,
314 fullscreenKey: function (event: KeyboardEvent) {
315 // fullscreen with the f key or Ctrl+Enter
316 return event.key === 'f' || (event.ctrlKey && event.key === 'Enter')
319 seekStep: function (event: KeyboardEvent) {
320 // mimic VLC seek behavior, and default to 5 (original value is 5).
321 if (event.ctrlKey && event.altKey) {
323 } else if (event.ctrlKey) {
325 } else if (event.altKey) {
333 increasePlaybackRateKey: {
334 key: function (event: KeyboardEvent) {
335 return event.key === '>'
337 handler: function (player: videojs.Player) {
338 player.playbackRate((player.playbackRate() + 0.1).toFixed(2))
341 decreasePlaybackRateKey: {
342 key: function (event: KeyboardEvent) {
343 return event.key === '<'
345 handler: function (player: videojs.Player) {
346 player.playbackRate((player.playbackRate() - 0.1).toFixed(2))
350 key: function (event: KeyboardEvent) {
351 return event.key === '.'
353 handler: function (player: videojs.Player) {
355 // Calculate movement distance (assuming 30 fps)
357 player.currentTime(player.currentTime() + dist)
365 if (commonOptions.language && !isDefaultLocale(commonOptions.language)) {
366 Object.assign(videojsOptions, { language: commonOptions.language })
369 return videojsOptions
372 private static getControlBarChildren (mode: PlayerMode, options: {
373 peertubeLink: boolean
374 theaterMode: boolean,
377 const settingEntries = []
378 const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar'
381 settingEntries.push('playbackRateMenuButton')
382 if (options.captions === true) settingEntries.push('captionsButton')
383 settingEntries.push('resolutionMenuButton')
387 'currentTimeDisplay': {},
389 'durationDisplay': {},
392 'flexibleWidthSpacer': {},
397 [loadProgressBar]: {},
398 'mouseTimeDisplay': {},
399 'playProgressBar': {}
414 entries: settingEntries
418 if (options.peertubeLink === true) {
419 Object.assign(children, {
420 'peerTubeLinkButton': {}
424 if (options.theaterMode === true) {
425 Object.assign(children, {
430 Object.assign(children, {
431 'fullscreenToggle': {}
437 private static addContextMenu (mode: PlayerMode, player: any, videoEmbedUrl: string) {
440 label: player.localize('Copy the video URL'),
441 listener: function () {
442 copyToClipboard(buildVideoLink())
446 label: player.localize('Copy the video URL at the current time'),
447 listener: function () {
448 const player = this as videojs.Player
449 copyToClipboard(buildVideoLink({ startTime: player.currentTime() }))
453 label: player.localize('Copy embed code'),
455 copyToClipboard(buildVideoEmbed(videoEmbedUrl))
460 if (mode === 'webtorrent') {
462 label: player.localize('Copy magnet URI'),
463 listener: function () {
464 const player = this as videojs.Player
465 copyToClipboard(player.webtorrent().getCurrentVideoFile().magnetUri)
470 player.contextmenuUI({ content })
473 private static getLocalePath (serverUrl: string, locale: string) {
474 const completeLocale = getCompleteLocale(locale)
476 if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined
478 return serverUrl + '/client/locales/' + completeLocale
482 // ############################################################################