]>
Commit | Line | Data |
---|---|---|
1 | import debug from 'debug' | |
2 | import videojs from 'video.js' | |
3 | import { logger } from '@root-helpers/logger' | |
4 | import { isMobile } from '@root-helpers/web-browser' | |
5 | import { timeToInt } from '@shared/core-utils' | |
6 | import { VideoView, VideoViewEvent } from '@shared/models/videos' | |
7 | import { | |
8 | getStoredLastSubtitle, | |
9 | getStoredMute, | |
10 | getStoredVolume, | |
11 | saveLastSubtitle, | |
12 | saveMuteInStore, | |
13 | saveVideoWatchHistory, | |
14 | saveVolumeInStore | |
15 | } from '../../peertube-player-local-storage' | |
16 | import { PeerTubePluginOptions, VideoJSCaption } from '../../types' | |
17 | import { SettingsButton } from '../settings/settings-menu-button' | |
18 | ||
19 | const debugLogger = debug('peertube:player:peertube') | |
20 | ||
21 | const Plugin = videojs.getPlugin('plugin') | |
22 | ||
23 | class PeerTubePlugin extends Plugin { | |
24 | private readonly videoViewUrl: string | |
25 | private readonly authorizationHeader: string | |
26 | ||
27 | private readonly videoUUID: string | |
28 | private readonly startTime: number | |
29 | ||
30 | private readonly CONSTANTS = { | |
31 | USER_VIEW_VIDEO_INTERVAL: 5000 // Every 5 seconds, notify the user is watching the video | |
32 | } | |
33 | ||
34 | private videoCaptions: VideoJSCaption[] | |
35 | private defaultSubtitle: string | |
36 | ||
37 | private videoViewInterval: any | |
38 | ||
39 | private menuOpened = false | |
40 | private mouseInControlBar = false | |
41 | private mouseInSettings = false | |
42 | private readonly initialInactivityTimeout: number | |
43 | ||
44 | constructor (player: videojs.Player, options?: PeerTubePluginOptions) { | |
45 | super(player) | |
46 | ||
47 | this.videoViewUrl = options.videoViewUrl | |
48 | this.authorizationHeader = options.authorizationHeader | |
49 | this.videoUUID = options.videoUUID | |
50 | this.startTime = timeToInt(options.startTime) | |
51 | ||
52 | this.videoCaptions = options.videoCaptions | |
53 | this.initialInactivityTimeout = this.player.options_.inactivityTimeout | |
54 | ||
55 | if (options.autoplay) this.player.addClass('vjs-has-autoplay') | |
56 | ||
57 | this.player.on('autoplay-failure', () => { | |
58 | this.player.removeClass('vjs-has-autoplay') | |
59 | }) | |
60 | ||
61 | this.player.ready(() => { | |
62 | const playerOptions = this.player.options_ | |
63 | ||
64 | const volume = getStoredVolume() | |
65 | if (volume !== undefined) this.player.volume(volume) | |
66 | ||
67 | const muted = playerOptions.muted !== undefined ? playerOptions.muted : getStoredMute() | |
68 | if (muted !== undefined) this.player.muted(muted) | |
69 | ||
70 | this.defaultSubtitle = options.subtitle || getStoredLastSubtitle() | |
71 | ||
72 | this.player.on('volumechange', () => { | |
73 | saveVolumeInStore(this.player.volume()) | |
74 | saveMuteInStore(this.player.muted()) | |
75 | }) | |
76 | ||
77 | if (options.stopTime) { | |
78 | const stopTime = timeToInt(options.stopTime) | |
79 | const self = this | |
80 | ||
81 | this.player.on('timeupdate', function onTimeUpdate () { | |
82 | if (self.player.currentTime() > stopTime) { | |
83 | self.player.pause() | |
84 | self.player.trigger('stopped') | |
85 | ||
86 | self.player.off('timeupdate', onTimeUpdate) | |
87 | } | |
88 | }) | |
89 | } | |
90 | ||
91 | this.player.textTracks().addEventListener('change', () => { | |
92 | const showing = this.player.textTracks().tracks_.find(t => { | |
93 | return t.kind === 'captions' && t.mode === 'showing' | |
94 | }) | |
95 | ||
96 | if (!showing) { | |
97 | saveLastSubtitle('off') | |
98 | return | |
99 | } | |
100 | ||
101 | saveLastSubtitle(showing.language) | |
102 | }) | |
103 | ||
104 | this.player.on('sourcechange', () => this.initCaptions()) | |
105 | ||
106 | this.player.duration(options.videoDuration) | |
107 | ||
108 | this.initializePlayer() | |
109 | this.runUserViewing() | |
110 | }) | |
111 | } | |
112 | ||
113 | dispose () { | |
114 | if (this.videoViewInterval) clearInterval(this.videoViewInterval) | |
115 | } | |
116 | ||
117 | onMenuOpened () { | |
118 | this.menuOpened = true | |
119 | this.alterInactivity() | |
120 | } | |
121 | ||
122 | onMenuClosed () { | |
123 | this.menuOpened = false | |
124 | this.alterInactivity() | |
125 | } | |
126 | ||
127 | displayFatalError () { | |
128 | this.player.loadingSpinner.hide() | |
129 | ||
130 | const buildModal = (error: MediaError) => { | |
131 | const localize = this.player.localize.bind(this.player) | |
132 | ||
133 | const wrapper = document.createElement('div') | |
134 | const header = document.createElement('h1') | |
135 | header.innerText = localize('Failed to play video') | |
136 | wrapper.appendChild(header) | |
137 | const desc = document.createElement('div') | |
138 | desc.innerText = localize('The video failed to play due to technical issues.') | |
139 | wrapper.appendChild(desc) | |
140 | const details = document.createElement('p') | |
141 | details.classList.add('error-details') | |
142 | details.innerText = error.message | |
143 | wrapper.appendChild(details) | |
144 | ||
145 | return wrapper | |
146 | } | |
147 | ||
148 | const modal = this.player.createModal(buildModal(this.player.error()), { | |
149 | temporary: false, | |
150 | uncloseable: true | |
151 | }) | |
152 | modal.addClass('vjs-custom-error-display') | |
153 | ||
154 | this.player.addClass('vjs-error-display-enabled') | |
155 | } | |
156 | ||
157 | hideFatalError () { | |
158 | this.player.removeClass('vjs-error-display-enabled') | |
159 | } | |
160 | ||
161 | private initializePlayer () { | |
162 | if (isMobile()) this.player.addClass('vjs-is-mobile') | |
163 | ||
164 | this.initSmoothProgressBar() | |
165 | ||
166 | this.initCaptions() | |
167 | ||
168 | this.listenControlBarMouse() | |
169 | ||
170 | this.listenFullScreenChange() | |
171 | } | |
172 | ||
173 | // --------------------------------------------------------------------------- | |
174 | ||
175 | private runUserViewing () { | |
176 | let lastCurrentTime = this.startTime | |
177 | let lastViewEvent: VideoViewEvent | |
178 | ||
179 | this.player.one('play', () => { | |
180 | this.notifyUserIsWatching(this.startTime, lastViewEvent) | |
181 | }) | |
182 | ||
183 | this.player.on('seeked', () => { | |
184 | // Don't take into account small seek events | |
185 | if (Math.abs(this.player.currentTime() - lastCurrentTime) < 3) return | |
186 | ||
187 | lastViewEvent = 'seek' | |
188 | }) | |
189 | ||
190 | this.player.one('ended', () => { | |
191 | const currentTime = Math.round(this.player.duration()) | |
192 | lastCurrentTime = currentTime | |
193 | ||
194 | this.notifyUserIsWatching(currentTime, lastViewEvent) | |
195 | ||
196 | lastViewEvent = undefined | |
197 | }) | |
198 | ||
199 | this.videoViewInterval = setInterval(() => { | |
200 | const currentTime = Math.round(this.player.currentTime()) | |
201 | ||
202 | // No need to update | |
203 | if (currentTime === lastCurrentTime) return | |
204 | ||
205 | lastCurrentTime = currentTime | |
206 | ||
207 | this.notifyUserIsWatching(currentTime, lastViewEvent) | |
208 | .catch(err => logger.error('Cannot notify user is watching.', err)) | |
209 | ||
210 | lastViewEvent = undefined | |
211 | ||
212 | // Server won't save history, so save the video position in local storage | |
213 | if (!this.authorizationHeader) { | |
214 | saveVideoWatchHistory(this.videoUUID, currentTime) | |
215 | } | |
216 | }, this.CONSTANTS.USER_VIEW_VIDEO_INTERVAL) | |
217 | } | |
218 | ||
219 | private notifyUserIsWatching (currentTime: number, viewEvent: VideoViewEvent) { | |
220 | if (!this.videoViewUrl) return Promise.resolve(undefined) | |
221 | ||
222 | const body: VideoView = { | |
223 | currentTime, | |
224 | viewEvent | |
225 | } | |
226 | ||
227 | const headers = new Headers({ | |
228 | 'Content-type': 'application/json; charset=UTF-8' | |
229 | }) | |
230 | ||
231 | if (this.authorizationHeader) headers.set('Authorization', this.authorizationHeader) | |
232 | ||
233 | return fetch(this.videoViewUrl, { method: 'POST', body: JSON.stringify(body), headers }) | |
234 | } | |
235 | ||
236 | // --------------------------------------------------------------------------- | |
237 | ||
238 | private listenFullScreenChange () { | |
239 | this.player.on('fullscreenchange', () => { | |
240 | if (this.player.isFullscreen()) this.player.focus() | |
241 | }) | |
242 | } | |
243 | ||
244 | private listenControlBarMouse () { | |
245 | const controlBar = this.player.controlBar | |
246 | const settingsButton: SettingsButton = (controlBar as any).settingsButton | |
247 | ||
248 | controlBar.on('mouseenter', () => { | |
249 | this.mouseInControlBar = true | |
250 | this.alterInactivity() | |
251 | }) | |
252 | ||
253 | controlBar.on('mouseleave', () => { | |
254 | this.mouseInControlBar = false | |
255 | this.alterInactivity() | |
256 | }) | |
257 | ||
258 | settingsButton.dialog.on('mouseenter', () => { | |
259 | this.mouseInSettings = true | |
260 | this.alterInactivity() | |
261 | }) | |
262 | ||
263 | settingsButton.dialog.on('mouseleave', () => { | |
264 | this.mouseInSettings = false | |
265 | this.alterInactivity() | |
266 | }) | |
267 | } | |
268 | ||
269 | private alterInactivity () { | |
270 | if (this.menuOpened || this.mouseInSettings || this.mouseInControlBar) { | |
271 | this.setInactivityTimeout(0) | |
272 | return | |
273 | } | |
274 | ||
275 | this.setInactivityTimeout(this.initialInactivityTimeout) | |
276 | this.player.reportUserActivity(true) | |
277 | } | |
278 | ||
279 | private setInactivityTimeout (timeout: number) { | |
280 | (this.player as any).cache_.inactivityTimeout = timeout | |
281 | this.player.options_.inactivityTimeout = timeout | |
282 | ||
283 | debugLogger('Set player inactivity to ' + timeout) | |
284 | } | |
285 | ||
286 | private initCaptions () { | |
287 | for (const caption of this.videoCaptions) { | |
288 | this.player.addRemoteTextTrack({ | |
289 | kind: 'captions', | |
290 | label: caption.label, | |
291 | language: caption.language, | |
292 | id: caption.language, | |
293 | src: caption.src, | |
294 | default: this.defaultSubtitle === caption.language | |
295 | }, false) | |
296 | } | |
297 | ||
298 | this.player.trigger('captionsChanged') | |
299 | } | |
300 | ||
301 | // Thanks: https://github.com/videojs/video.js/issues/4460#issuecomment-312861657 | |
302 | private initSmoothProgressBar () { | |
303 | const SeekBar = videojs.getComponent('SeekBar') as any | |
304 | SeekBar.prototype.getPercent = function getPercent () { | |
305 | // Allows for smooth scrubbing, when player can't keep up. | |
306 | // const time = (this.player_.scrubbing()) ? | |
307 | // this.player_.getCache().currentTime : | |
308 | // this.player_.currentTime() | |
309 | const time = this.player_.currentTime() | |
310 | const percent = time / this.player_.duration() | |
311 | return percent >= 1 ? 1 : percent | |
312 | } | |
313 | SeekBar.prototype.handleMouseMove = function handleMouseMove (event: any) { | |
314 | let newTime = this.calculateDistance(event) * this.player_.duration() | |
315 | if (newTime === this.player_.duration()) { | |
316 | newTime = newTime - 0.1 | |
317 | } | |
318 | this.player_.currentTime(newTime) | |
319 | this.update() | |
320 | } | |
321 | } | |
322 | } | |
323 | ||
324 | videojs.registerPlugin('peertube', PeerTubePlugin) | |
325 | export { PeerTubePlugin } |