]>
Commit | Line | Data |
---|---|---|
2adfc7ea C |
1 | import { VideoFile } from '../../../../shared/models/videos' |
2 | // @ts-ignore | |
3 | import * as videojs from 'video.js' | |
4 | import 'videojs-hotkeys' | |
5 | import 'videojs-dock' | |
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' | |
09209296 | 16 | import { buildVideoEmbed, buildVideoLink, copyToClipboard, getRtcConfig } from './utils' |
2adfc7ea | 17 | import { getCompleteLocale, getShortLocale, is18nLocale, isDefaultLocale } from '../../../../shared/models/i18n/i18n' |
09209296 C |
18 | import { segmentValidatorFactory } from './p2p-media-loader/segment-validator' |
19 | import { segmentUrlBuilderFactory } from './p2p-media-loader/segment-url-builder' | |
da332417 | 20 | import { RedundancyUrlManager } from './p2p-media-loader/redundancy-url-manager' |
2adfc7ea C |
21 | |
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_ = ' ' | |
28 | ||
3b6f205c | 29 | export type PlayerMode = 'webtorrent' | 'p2p-media-loader' |
2adfc7ea | 30 | |
3b6f205c | 31 | export type WebtorrentOptions = { |
2adfc7ea C |
32 | videoFiles: VideoFile[] |
33 | } | |
34 | ||
3b6f205c | 35 | export type P2PMediaLoaderOptions = { |
2adfc7ea | 36 | playlistUrl: string |
09209296 | 37 | segmentsSha256Url: string |
4348a27d | 38 | trackerAnnounce: string[] |
09209296 C |
39 | redundancyBaseUrls: string[] |
40 | videoFiles: VideoFile[] | |
2adfc7ea C |
41 | } |
42 | ||
5efab546 C |
43 | export interface CustomizationOptions { |
44 | startTime: number | string | |
45 | stopTime: number | string | |
46 | ||
47 | controls?: boolean | |
48 | muted?: boolean | |
49 | loop?: boolean | |
50 | subtitle?: string | |
51 | ||
52 | peertubeLink: boolean | |
53 | } | |
54 | ||
55 | export interface CommonOptions extends CustomizationOptions { | |
2adfc7ea | 56 | playerElement: HTMLVideoElement |
6ec0b75b | 57 | onPlayerElementChange: (element: HTMLVideoElement) => void |
2adfc7ea C |
58 | |
59 | autoplay: boolean | |
60 | videoDuration: number | |
61 | enableHotkeys: boolean | |
62 | inactivityTimeout: number | |
63 | poster: string | |
2adfc7ea C |
64 | |
65 | theaterMode: boolean | |
66 | captions: boolean | |
2adfc7ea C |
67 | |
68 | videoViewUrl: string | |
69 | embedUrl: string | |
70 | ||
71 | language?: string | |
2adfc7ea C |
72 | |
73 | videoCaptions: VideoJSCaption[] | |
74 | ||
75 | userWatching?: UserWatching | |
76 | ||
77 | serverUrl: string | |
78 | } | |
79 | ||
80 | export type PeertubePlayerManagerOptions = { | |
81 | common: CommonOptions, | |
6ec0b75b | 82 | webtorrent: WebtorrentOptions, |
2adfc7ea C |
83 | p2pMediaLoader?: P2PMediaLoaderOptions |
84 | } | |
85 | ||
86 | export class PeertubePlayerManager { | |
87 | ||
88 | private static videojsLocaleCache: { [ path: string ]: any } = {} | |
6ec0b75b | 89 | private static playerElementClassName: string |
bfbd9128 | 90 | private static onPlayerChange: (player: any) => void |
2adfc7ea C |
91 | |
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) | |
96 | ||
97 | return fetch(path + '/server.json') | |
98 | .then(res => res.json()) | |
99 | .catch(err => { | |
100 | console.error('Cannot get server translations', err) | |
101 | return undefined | |
102 | }) | |
103 | } | |
104 | ||
bfbd9128 | 105 | static async initialize (mode: PlayerMode, options: PeertubePlayerManagerOptions, onPlayerChange: (player: any) => void) { |
4348a27d C |
106 | let p2pMediaLoader: any |
107 | ||
bfbd9128 | 108 | this.onPlayerChange = onPlayerChange |
6ec0b75b C |
109 | this.playerElementClassName = options.common.playerElement.className |
110 | ||
09209296 | 111 | if (mode === 'webtorrent') await import('./webtorrent/webtorrent-plugin') |
4348a27d C |
112 | if (mode === 'p2p-media-loader') { |
113 | [ p2pMediaLoader ] = await Promise.all([ | |
114 | import('p2p-media-loader-hlsjs'), | |
09209296 | 115 | import('./p2p-media-loader/p2p-media-loader-plugin') |
4348a27d C |
116 | ]) |
117 | } | |
2adfc7ea | 118 | |
4348a27d | 119 | const videojsOptions = this.getVideojsOptions(mode, options, p2pMediaLoader) |
2adfc7ea C |
120 | |
121 | await this.loadLocaleInVideoJS(options.common.serverUrl, options.common.language) | |
122 | ||
123 | const self = this | |
124 | return new Promise(res => { | |
125 | videojs(options.common.playerElement, videojsOptions, function (this: any) { | |
126 | const player = this | |
127 | ||
536598cf C |
128 | let alreadyFallback = false |
129 | ||
130 | player.tech_.one('error', () => { | |
131 | if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options) | |
132 | alreadyFallback = true | |
133 | }) | |
134 | ||
135 | player.one('error', () => { | |
136 | if (!alreadyFallback) self.maybeFallbackToWebTorrent(mode, player, options) | |
137 | alreadyFallback = true | |
138 | }) | |
6ec0b75b | 139 | |
2adfc7ea C |
140 | self.addContextMenu(mode, player, options.common.embedUrl) |
141 | ||
142 | return res(player) | |
143 | }) | |
144 | }) | |
145 | } | |
146 | ||
96cb4527 C |
147 | private static async maybeFallbackToWebTorrent (currentMode: PlayerMode, player: any, options: PeertubePlayerManagerOptions) { |
148 | if (currentMode === 'webtorrent') return | |
149 | ||
150 | console.log('Fallback to webtorrent.') | |
151 | ||
6ec0b75b C |
152 | const newVideoElement = document.createElement('video') |
153 | newVideoElement.className = this.playerElementClassName | |
154 | ||
155 | // VideoJS wraps our video element inside a div | |
96cb4527 C |
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 | |
159 | ||
6ec0b75b C |
160 | currentParentPlayerElement.parentNode.insertBefore(newVideoElement, currentParentPlayerElement) |
161 | ||
162 | options.common.playerElement = newVideoElement | |
163 | options.common.onPlayerElementChange(newVideoElement) | |
164 | ||
165 | player.dispose() | |
166 | ||
167 | await import('./webtorrent/webtorrent-plugin') | |
168 | ||
169 | const mode = 'webtorrent' | |
170 | const videojsOptions = this.getVideojsOptions(mode, options) | |
171 | ||
172 | const self = this | |
173 | videojs(newVideoElement, videojsOptions, function (this: any) { | |
174 | const player = this | |
175 | ||
176 | self.addContextMenu(mode, player, options.common.embedUrl) | |
bfbd9128 C |
177 | |
178 | PeertubePlayerManager.onPlayerChange(player) | |
6ec0b75b C |
179 | }) |
180 | } | |
181 | ||
2adfc7ea C |
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) | |
186 | ||
187 | let p: Promise<any> | |
188 | ||
189 | if (PeertubePlayerManager.videojsLocaleCache[path]) { | |
190 | p = Promise.resolve(PeertubePlayerManager.videojsLocaleCache[path]) | |
191 | } else { | |
192 | p = fetch(path + '/player.json') | |
193 | .then(res => res.json()) | |
194 | .then(json => { | |
195 | PeertubePlayerManager.videojsLocaleCache[path] = json | |
196 | return json | |
197 | }) | |
198 | .catch(err => { | |
199 | console.error('Cannot get player translations', err) | |
200 | return undefined | |
201 | }) | |
202 | } | |
203 | ||
204 | const completeLocale = getCompleteLocale(locale) | |
205 | return p.then(json => videojs.addLanguage(getShortLocale(completeLocale), json)) | |
206 | } | |
207 | ||
4348a27d | 208 | private static getVideojsOptions (mode: PlayerMode, options: PeertubePlayerManagerOptions, p2pMediaLoaderModule?: any) { |
2adfc7ea C |
209 | const commonOptions = options.common |
210 | const webtorrentOptions = options.webtorrent | |
211 | const p2pMediaLoaderOptions = options.p2pMediaLoader | |
09209296 C |
212 | |
213 | let autoplay = options.common.autoplay | |
3b6f205c | 214 | let html5 = {} |
2adfc7ea C |
215 | |
216 | const plugins: VideoJSPluginOptions = { | |
217 | peertube: { | |
09209296 C |
218 | mode, |
219 | autoplay, // Use peertube plugin autoplay because we get the file by webtorrent | |
2adfc7ea C |
220 | videoViewUrl: commonOptions.videoViewUrl, |
221 | videoDuration: commonOptions.videoDuration, | |
2adfc7ea C |
222 | userWatching: commonOptions.userWatching, |
223 | subtitle: commonOptions.subtitle, | |
f0a39880 C |
224 | videoCaptions: commonOptions.videoCaptions, |
225 | stopTime: commonOptions.stopTime | |
2adfc7ea C |
226 | } |
227 | } | |
228 | ||
6ec0b75b | 229 | if (mode === 'p2p-media-loader') { |
da332417 C |
230 | const redundancyUrlManager = new RedundancyUrlManager(options.p2pMediaLoader.redundancyBaseUrls) |
231 | ||
2adfc7ea | 232 | const p2pMediaLoader: P2PMediaLoaderPluginOptions = { |
da332417 | 233 | redundancyUrlManager, |
2adfc7ea | 234 | type: 'application/x-mpegURL', |
f0a39880 | 235 | startTime: commonOptions.startTime, |
2adfc7ea C |
236 | src: p2pMediaLoaderOptions.playlistUrl |
237 | } | |
238 | ||
09209296 C |
239 | const trackerAnnounce = p2pMediaLoaderOptions.trackerAnnounce |
240 | .filter(t => t.startsWith('ws')) | |
241 | ||
4348a27d | 242 | const p2pMediaLoaderConfig = { |
09209296 C |
243 | loader: { |
244 | trackerAnnounce, | |
245 | segmentValidator: segmentValidatorFactory(options.p2pMediaLoader.segmentsSha256Url), | |
246 | rtcConfig: getRtcConfig(), | |
247 | requiredSegmentsPriority: 5, | |
da332417 | 248 | segmentUrlBuilder: segmentUrlBuilderFactory(redundancyUrlManager) |
09209296 | 249 | }, |
2adfc7ea | 250 | segments: { |
4348a27d | 251 | swarmId: p2pMediaLoaderOptions.playlistUrl |
2adfc7ea C |
252 | } |
253 | } | |
254 | const streamrootHls = { | |
09209296 C |
255 | levelLabelHandler: (level: { height: number, width: number }) => { |
256 | const file = p2pMediaLoaderOptions.videoFiles.find(f => f.resolution.id === level.height) | |
257 | ||
258 | let label = file.resolution.label | |
259 | if (file.fps >= 50) label += file.fps | |
260 | ||
261 | return label | |
262 | }, | |
2adfc7ea C |
263 | html5: { |
264 | hlsjsConfig: { | |
84ddb975 | 265 | autoStartLoad: false, |
2adfc7ea | 266 | liveSyncDurationCount: 7, |
4348a27d | 267 | loader: new p2pMediaLoaderModule.Engine(p2pMediaLoaderConfig).createLoaderClass() |
2adfc7ea C |
268 | } |
269 | } | |
270 | } | |
271 | ||
272 | Object.assign(plugins, { p2pMediaLoader, streamrootHls }) | |
3b6f205c | 273 | html5 = streamrootHls.html5 |
2adfc7ea C |
274 | } |
275 | ||
6ec0b75b | 276 | if (mode === 'webtorrent') { |
2adfc7ea | 277 | const webtorrent = { |
09209296 | 278 | autoplay, |
2adfc7ea C |
279 | videoDuration: commonOptions.videoDuration, |
280 | playerElement: commonOptions.playerElement, | |
f0a39880 C |
281 | videoFiles: webtorrentOptions.videoFiles, |
282 | startTime: commonOptions.startTime | |
2adfc7ea C |
283 | } |
284 | Object.assign(plugins, { webtorrent }) | |
09209296 C |
285 | |
286 | // WebTorrent plugin handles autoplay, because we do some hackish stuff in there | |
287 | autoplay = false | |
2adfc7ea C |
288 | } |
289 | ||
290 | const videojsOptions = { | |
3b6f205c C |
291 | html5, |
292 | ||
2adfc7ea C |
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, | |
297 | ||
298 | muted: commonOptions.muted !== undefined | |
299 | ? commonOptions.muted | |
300 | : undefined, // Undefined so the player knows it has to check the local storage | |
301 | ||
302 | poster: commonOptions.poster, | |
6ec0b75b | 303 | autoplay: autoplay === true ? 'any' : autoplay, // Use 'any' instead of true to get notifier by videojs if autoplay fails |
2adfc7ea C |
304 | inactivityTimeout: commonOptions.inactivityTimeout, |
305 | playbackRates: [ 0.5, 0.75, 1, 1.25, 1.5, 2 ], | |
306 | plugins, | |
307 | controlBar: { | |
308 | children: this.getControlBarChildren(mode, { | |
309 | captions: commonOptions.captions, | |
310 | peertubeLink: commonOptions.peertubeLink, | |
311 | theaterMode: commonOptions.theaterMode | |
312 | }) | |
313 | } | |
314 | } | |
315 | ||
316 | if (commonOptions.enableHotkeys === true) { | |
317 | Object.assign(videojsOptions.plugins, { | |
318 | hotkeys: { | |
319 | enableVolumeScroll: false, | |
320 | enableModifiersForNumbers: false, | |
321 | ||
322 | fullscreenKey: function (event: KeyboardEvent) { | |
323 | // fullscreen with the f key or Ctrl+Enter | |
324 | return event.key === 'f' || (event.ctrlKey && event.key === 'Enter') | |
325 | }, | |
326 | ||
327 | seekStep: function (event: KeyboardEvent) { | |
328 | // mimic VLC seek behavior, and default to 5 (original value is 5). | |
329 | if (event.ctrlKey && event.altKey) { | |
330 | return 5 * 60 | |
331 | } else if (event.ctrlKey) { | |
332 | return 60 | |
333 | } else if (event.altKey) { | |
334 | return 10 | |
335 | } else { | |
336 | return 5 | |
337 | } | |
338 | }, | |
339 | ||
340 | customKeys: { | |
341 | increasePlaybackRateKey: { | |
342 | key: function (event: KeyboardEvent) { | |
343 | return event.key === '>' | |
344 | }, | |
345 | handler: function (player: videojs.Player) { | |
346 | player.playbackRate((player.playbackRate() + 0.1).toFixed(2)) | |
347 | } | |
348 | }, | |
349 | decreasePlaybackRateKey: { | |
350 | key: function (event: KeyboardEvent) { | |
351 | return event.key === '<' | |
352 | }, | |
353 | handler: function (player: videojs.Player) { | |
354 | player.playbackRate((player.playbackRate() - 0.1).toFixed(2)) | |
355 | } | |
356 | }, | |
357 | frameByFrame: { | |
358 | key: function (event: KeyboardEvent) { | |
359 | return event.key === '.' | |
360 | }, | |
361 | handler: function (player: videojs.Player) { | |
362 | player.pause() | |
363 | // Calculate movement distance (assuming 30 fps) | |
364 | const dist = 1 / 30 | |
365 | player.currentTime(player.currentTime() + dist) | |
366 | } | |
367 | } | |
368 | } | |
369 | } | |
370 | }) | |
371 | } | |
372 | ||
373 | if (commonOptions.language && !isDefaultLocale(commonOptions.language)) { | |
374 | Object.assign(videojsOptions, { language: commonOptions.language }) | |
375 | } | |
376 | ||
377 | return videojsOptions | |
378 | } | |
379 | ||
380 | private static getControlBarChildren (mode: PlayerMode, options: { | |
381 | peertubeLink: boolean | |
382 | theaterMode: boolean, | |
383 | captions: boolean | |
384 | }) { | |
385 | const settingEntries = [] | |
386 | const loadProgressBar = mode === 'webtorrent' ? 'peerTubeLoadProgressBar' : 'loadProgressBar' | |
387 | ||
388 | // Keep an order | |
389 | settingEntries.push('playbackRateMenuButton') | |
390 | if (options.captions === true) settingEntries.push('captionsButton') | |
391 | settingEntries.push('resolutionMenuButton') | |
392 | ||
393 | const children = { | |
394 | 'playToggle': {}, | |
395 | 'currentTimeDisplay': {}, | |
396 | 'timeDivider': {}, | |
397 | 'durationDisplay': {}, | |
398 | 'liveDisplay': {}, | |
399 | ||
400 | 'flexibleWidthSpacer': {}, | |
401 | 'progressControl': { | |
402 | children: { | |
403 | 'seekBar': { | |
404 | children: { | |
405 | [loadProgressBar]: {}, | |
406 | 'mouseTimeDisplay': {}, | |
407 | 'playProgressBar': {} | |
408 | } | |
409 | } | |
410 | } | |
411 | }, | |
412 | ||
413 | 'p2PInfoButton': {}, | |
414 | ||
415 | 'muteToggle': {}, | |
416 | 'volumeControl': {}, | |
417 | ||
418 | 'settingsButton': { | |
419 | setup: { | |
420 | maxHeightOffset: 40 | |
421 | }, | |
422 | entries: settingEntries | |
423 | } | |
424 | } | |
425 | ||
426 | if (options.peertubeLink === true) { | |
427 | Object.assign(children, { | |
428 | 'peerTubeLinkButton': {} | |
429 | }) | |
430 | } | |
431 | ||
432 | if (options.theaterMode === true) { | |
433 | Object.assign(children, { | |
434 | 'theaterButton': {} | |
435 | }) | |
436 | } | |
437 | ||
438 | Object.assign(children, { | |
439 | 'fullscreenToggle': {} | |
440 | }) | |
441 | ||
442 | return children | |
443 | } | |
444 | ||
445 | private static addContextMenu (mode: PlayerMode, player: any, videoEmbedUrl: string) { | |
446 | const content = [ | |
447 | { | |
448 | label: player.localize('Copy the video URL'), | |
449 | listener: function () { | |
450 | copyToClipboard(buildVideoLink()) | |
451 | } | |
452 | }, | |
453 | { | |
454 | label: player.localize('Copy the video URL at the current time'), | |
455 | listener: function () { | |
456 | const player = this as videojs.Player | |
2f4c784a | 457 | copyToClipboard(buildVideoLink({ startTime: player.currentTime() })) |
2adfc7ea C |
458 | } |
459 | }, | |
460 | { | |
461 | label: player.localize('Copy embed code'), | |
462 | listener: () => { | |
463 | copyToClipboard(buildVideoEmbed(videoEmbedUrl)) | |
464 | } | |
465 | } | |
466 | ] | |
467 | ||
468 | if (mode === 'webtorrent') { | |
469 | content.push({ | |
470 | label: player.localize('Copy magnet URI'), | |
471 | listener: function () { | |
472 | const player = this as videojs.Player | |
473 | copyToClipboard(player.webtorrent().getCurrentVideoFile().magnetUri) | |
474 | } | |
475 | }) | |
476 | } | |
477 | ||
478 | player.contextmenuUI({ content }) | |
479 | } | |
480 | ||
481 | private static getLocalePath (serverUrl: string, locale: string) { | |
482 | const completeLocale = getCompleteLocale(locale) | |
483 | ||
484 | if (!is18nLocale(completeLocale) || isDefaultLocale(completeLocale)) return undefined | |
485 | ||
486 | return serverUrl + '/client/locales/' + completeLocale | |
487 | } | |
488 | } | |
489 | ||
490 | // ############################################################################ | |
491 | ||
492 | export { | |
493 | videojs | |
494 | } |