]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - client/src/standalone/videos/embed.ts
Update client dep
[github/Chocobozzz/PeerTube.git] / client / src / standalone / videos / embed.ts
CommitLineData
202e7223
C
1import './embed.scss'
2
99941732 3import * as Channel from 'jschannel'
c6352f2c 4
3dfa8494 5import { peertubeTranslate, ResultList, VideoDetails } from '../../../../shared'
902aa3a0 6import { PeerTubeResolution } from '../player/definitions'
16f7022b 7import { VideoJSCaption } from '../../assets/player/peertube-videojs-typings'
59c76ffa 8import { VideoCaption } from '../../../../shared/models/videos/caption/video-caption.model'
09209296
C
9import {
10 P2PMediaLoaderOptions,
11 PeertubePlayerManager,
12 PeertubePlayerManagerOptions,
13 PlayerMode
14} from '../../assets/player/peertube-player-manager'
15import { VideoStreamingPlaylistType } from '../../../../shared/models/videos/video-streaming-playlist.type'
202e7223 16
99941732 17/**
902aa3a0 18 * Embed API exposes control of the embed player to the outside world via
99941732
WL
19 * JSChannels and window.postMessage
20 */
21class PeerTubeEmbedApi {
902aa3a0 22 private channel: Channel.MessagingChannel
99941732 23 private isReady = false
902aa3a0
C
24 private resolutions: PeerTubeResolution[] = null
25
26 constructor (private embed: PeerTubeEmbed) {
27 }
d4f3fea6 28
902aa3a0 29 initialize () {
99941732
WL
30 this.constructChannel()
31 this.setupStateTracking()
d4f3fea6 32
99941732 33 // We're ready!
d4f3fea6 34
99941732
WL
35 this.notifyReady()
36 }
902aa3a0
C
37
38 private get element () {
99941732
WL
39 return this.embed.videoElement
40 }
d4f3fea6 41
902aa3a0 42 private constructChannel () {
99941732 43 let channel = Channel.build({ window: window.parent, origin: '*', scope: this.embed.scope })
902aa3a0 44
99941732
WL
45 channel.bind('play', (txn, params) => this.embed.player.play())
46 channel.bind('pause', (txn, params) => this.embed.player.pause())
47 channel.bind('seek', (txn, time) => this.embed.player.currentTime(time))
48 channel.bind('setVolume', (txn, value) => this.embed.player.volume(value))
49 channel.bind('getVolume', (txn, value) => this.embed.player.volume())
50 channel.bind('isReady', (txn, params) => this.isReady)
51 channel.bind('setResolution', (txn, resolutionId) => this.setResolution(resolutionId))
52 channel.bind('getResolutions', (txn, params) => this.resolutions)
53 channel.bind('setPlaybackRate', (txn, playbackRate) => this.embed.player.playbackRate(playbackRate))
54 channel.bind('getPlaybackRate', (txn, params) => this.embed.player.playbackRate())
55 channel.bind('getPlaybackRates', (txn, params) => this.embed.playerOptions.playbackRates)
d4f3fea6 56
99941732
WL
57 this.channel = channel
58 }
d4f3fea6 59
902aa3a0 60 private setResolution (resolutionId: number) {
2adfc7ea 61 if (resolutionId === -1 && this.embed.player.webtorrent().isAutoResolutionForbidden()) return
99941732
WL
62
63 // Auto resolution
64 if (resolutionId === -1) {
2adfc7ea 65 this.embed.player.webtorrent().enableAutoResolution()
99941732
WL
66 return
67 }
68
2adfc7ea
C
69 this.embed.player.webtorrent().disableAutoResolution()
70 this.embed.player.webtorrent().updateResolution(resolutionId)
99941732
WL
71 }
72
73 /**
74 * Let the host know that we're ready to go!
75 */
902aa3a0 76 private notifyReady () {
99941732
WL
77 this.isReady = true
78 this.channel.notify({ method: 'ready', params: true })
79 }
80
902aa3a0
C
81 private setupStateTracking () {
82 let currentState: 'playing' | 'paused' | 'unstarted' = 'unstarted'
99941732
WL
83
84 setInterval(() => {
85 let position = this.element.currentTime
86 let volume = this.element.volume
87
88 this.channel.notify({
89 method: 'playbackStatusUpdate',
90 params: {
91 position,
92 volume,
902aa3a0 93 playbackState: currentState
99941732
WL
94 }
95 })
96 }, 500)
97
98 this.element.addEventListener('play', ev => {
99 currentState = 'playing'
100 this.channel.notify({ method: 'playbackStatusChange', params: 'playing' })
101 })
102
103 this.element.addEventListener('pause', ev => {
104 currentState = 'paused'
105 this.channel.notify({ method: 'playbackStatusChange', params: 'paused' })
106 })
107
108 // PeerTube specific capabilities
109
2adfc7ea
C
110 if (this.embed.player.webtorrent) {
111 this.embed.player.webtorrent().on('autoResolutionUpdate', () => this.loadWebTorrentResolutions())
112 this.embed.player.webtorrent().on('videoFileUpdate', () => this.loadWebTorrentResolutions())
113 }
99941732
WL
114 }
115
2adfc7ea 116 private loadWebTorrentResolutions () {
99941732 117 let resolutions = []
2adfc7ea 118 let currentResolutionId = this.embed.player.webtorrent().getCurrentResolutionId()
99941732 119
2adfc7ea 120 for (const videoFile of this.embed.player.webtorrent().videoFiles) {
99941732
WL
121 let label = videoFile.resolution.label
122 if (videoFile.fps && videoFile.fps >= 50) {
123 label += videoFile.fps
124 }
d4f3fea6 125
99941732
WL
126 resolutions.push({
127 id: videoFile.resolution.id,
128 label,
129 src: videoFile.magnetUri,
130 active: videoFile.resolution.id === currentResolutionId
131 })
132 }
133
134 this.resolutions = resolutions
135 this.channel.notify({
136 method: 'resolutionUpdate',
137 params: this.resolutions
138 })
139 }
202e7223
C
140}
141
99941732 142class PeerTubeEmbed {
902aa3a0
C
143 videoElement: HTMLVideoElement
144 player: any
145 playerOptions: any
146 api: PeerTubeEmbedApi = null
3b019808
C
147 autoplay: boolean
148 controls: boolean
149 muted: boolean
150 loop: boolean
151 subtitle: string
902aa3a0 152 enableApi = false
1f6824c9 153 startTime: number | string = 0
f0a39880 154 stopTime: number | string
3b6f205c 155 mode: PlayerMode
902aa3a0
C
156 scope = 'peertube'
157
158 static async main () {
c6352f2c 159 const videoContainerId = 'video-container'
99941732
WL
160 const embed = new PeerTubeEmbed(videoContainerId)
161 await embed.init()
162 }
902aa3a0
C
163
164 constructor (private videoContainerId: string) {
165 this.videoElement = document.getElementById(videoContainerId) as HTMLVideoElement
166 }
167
99941732
WL
168 getVideoUrl (id: string) {
169 return window.location.origin + '/api/v1/videos/' + id
170 }
d4f3fea6 171
99941732
WL
172 loadVideoInfo (videoId: string): Promise<Response> {
173 return fetch(this.getVideoUrl(videoId))
174 }
d4f3fea6 175
16f7022b
C
176 loadVideoCaptions (videoId: string): Promise<Response> {
177 return fetch(this.getVideoUrl(videoId) + '/captions')
178 }
179
99941732
WL
180 removeElement (element: HTMLElement) {
181 element.parentElement.removeChild(element)
182 }
d4f3fea6 183
ad3fa0c5 184 displayError (text: string, translations?: { [ id: string ]: string }) {
99941732 185 // Remove video element
6d88de72 186 if (this.videoElement) this.removeElement(this.videoElement)
99941732 187
ad3fa0c5
C
188 const translatedText = peertubeTranslate(text, translations)
189 const translatedSorry = peertubeTranslate('Sorry', translations)
190
191 document.title = translatedSorry + ' - ' + translatedText
99941732
WL
192
193 const errorBlock = document.getElementById('error-block')
194 errorBlock.style.display = 'flex'
195
ad3fa0c5
C
196 const errorTitle = document.getElementById('error-title')
197 errorTitle.innerHTML = peertubeTranslate('Sorry', translations)
198
99941732 199 const errorText = document.getElementById('error-content')
ad3fa0c5 200 errorText.innerHTML = translatedText
99941732
WL
201 }
202
ad3fa0c5 203 videoNotFound (translations?: { [ id: string ]: string }) {
99941732 204 const text = 'This video does not exist.'
ad3fa0c5 205 this.displayError(text, translations)
99941732
WL
206 }
207
ad3fa0c5 208 videoFetchError (translations?: { [ id: string ]: string }) {
99941732 209 const text = 'We cannot fetch the video. Please try again later.'
ad3fa0c5 210 this.displayError(text, translations)
99941732
WL
211 }
212
3b019808 213 getParamToggle (params: URLSearchParams, name: string, defaultValue?: boolean) {
99941732
WL
214 return params.has(name) ? (params.get(name) === '1' || params.get(name) === 'true') : defaultValue
215 }
d4f3fea6 216
3b019808 217 getParamString (params: URLSearchParams, name: string, defaultValue?: string) {
99941732
WL
218 return params.has(name) ? params.get(name) : defaultValue
219 }
da99ccf2 220
902aa3a0 221 async init () {
99941732
WL
222 try {
223 await this.initCore()
224 } catch (e) {
225 console.error(e)
226 }
227 }
228
902aa3a0
C
229 private initializeApi () {
230 if (!this.enableApi) return
231
232 this.api = new PeerTubeEmbedApi(this)
233 this.api.initialize()
234 }
235
236 private loadParams () {
da99ccf2
C
237 try {
238 let params = new URL(window.location.toString()).searchParams
99941732 239
3b019808
C
240 this.autoplay = this.getParamToggle(params, 'autoplay')
241 this.controls = this.getParamToggle(params, 'controls')
242 this.muted = this.getParamToggle(params, 'muted')
243 this.loop = this.getParamToggle(params, 'loop')
99941732 244 this.enableApi = this.getParamToggle(params, 'api', this.enableApi)
f37bad63 245
3b019808
C
246 this.scope = this.getParamString(params, 'scope', this.scope)
247 this.subtitle = this.getParamString(params, 'subtitle')
248 this.startTime = this.getParamString(params, 'start')
f0a39880 249 this.stopTime = this.getParamString(params, 'stop')
3b6f205c 250
597a9266 251 this.mode = this.getParamString(params, 'mode') === 'p2p-media-loader' ? 'p2p-media-loader' : 'webtorrent'
da99ccf2
C
252 } catch (err) {
253 console.error('Cannot get params from URL.', err)
254 }
99941732
WL
255 }
256
902aa3a0 257 private async initCore () {
6385c0cb
C
258 const urlParts = window.location.pathname.split('/')
259 const videoId = urlParts[ urlParts.length - 1 ]
99941732 260
2adfc7ea
C
261 const [ serverTranslations, videoResponse, captionsResponse ] = await Promise.all([
262 PeertubePlayerManager.getServerTranslations(window.location.origin, navigator.language),
16f7022b
C
263 this.loadVideoInfo(videoId),
264 this.loadVideoCaptions(videoId)
265 ])
99941732 266
16f7022b 267 if (!videoResponse.ok) {
ad3fa0c5 268 if (videoResponse.status === 404) return this.videoNotFound(serverTranslations)
99941732 269
ad3fa0c5 270 return this.videoFetchError(serverTranslations)
99941732
WL
271 }
272
16f7022b
C
273 const videoInfo: VideoDetails = await videoResponse.json()
274 let videoCaptions: VideoJSCaption[] = []
275 if (captionsResponse.ok) {
276 const { data } = (await captionsResponse.json()) as ResultList<VideoCaption>
277 videoCaptions = data.map(c => ({
3dfa8494 278 label: peertubeTranslate(c.language.label, serverTranslations),
16f7022b
C
279 language: c.language.id,
280 src: window.location.origin + c.captionPath
281 }))
282 }
99941732
WL
283
284 this.loadParams()
da99ccf2 285
2adfc7ea
C
286 const options: PeertubePlayerManagerOptions = {
287 common: {
288 autoplay: this.autoplay,
289 controls: this.controls,
290 muted: this.muted,
291 loop: this.loop,
292 captions: videoCaptions.length !== 0,
293 startTime: this.startTime,
f0a39880 294 stopTime: this.stopTime,
2adfc7ea
C
295 subtitle: this.subtitle,
296
297 videoCaptions,
298 inactivityTimeout: 1500,
299 videoViewUrl: this.getVideoUrl(videoId) + '/views',
6ec0b75b 300
2adfc7ea 301 playerElement: this.videoElement,
6ec0b75b
C
302 onPlayerElementChange: (element: HTMLVideoElement) => this.videoElement = element,
303
2adfc7ea
C
304 videoDuration: videoInfo.duration,
305 enableHotkeys: true,
306 peertubeLink: true,
307 poster: window.location.origin + videoInfo.previewPath,
308 theaterMode: false,
309
310 serverUrl: window.location.origin,
311 language: navigator.language,
312 embedUrl: window.location.origin + videoInfo.embedPath
6ec0b75b
C
313 },
314
315 webtorrent: {
316 videoFiles: videoInfo.files
2adfc7ea 317 }
3b6f205c 318 }
2adfc7ea 319
3b6f205c 320 if (this.mode === 'p2p-media-loader') {
09209296
C
321 const hlsPlaylist = videoInfo.streamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
322
3b6f205c
C
323 Object.assign(options, {
324 p2pMediaLoader: {
09209296
C
325 playlistUrl: hlsPlaylist.playlistUrl,
326 segmentsSha256Url: hlsPlaylist.segmentsSha256Url,
327 redundancyBaseUrls: hlsPlaylist.redundancies.map(r => r.baseUrl),
328 trackerAnnounce: videoInfo.trackerUrls,
329 videoFiles: videoInfo.files
330 } as P2PMediaLoaderOptions
3b6f205c 331 })
2adfc7ea 332 }
202e7223 333
3b6f205c 334 this.player = await PeertubePlayerManager.initialize(this.mode, options)
e945b184 335
2adfc7ea 336 this.player.on('customError', (event: any, data: any) => this.handleError(data.err, serverTranslations))
99941732 337
2adfc7ea 338 window[ 'videojsPlayer' ] = this.player
902aa3a0 339
2adfc7ea
C
340 if (this.controls) {
341 this.player.dock({
342 title: videoInfo.name,
343 description: this.player.localize('Uses P2P, others may know your IP is downloading this video.')
344 })
345 }
16f7022b 346
2adfc7ea 347 this.initializeApi()
99941732 348 }
6d88de72 349
ad3fa0c5 350 private handleError (err: Error, translations?: { [ id: string ]: string }) {
0f7fedc3 351 if (err.message.indexOf('from xs param') !== -1) {
6d88de72
C
352 this.player.dispose()
353 this.videoElement = null
ad3fa0c5 354 this.displayError('This video is not available because the remote instance is not responding.', translations)
6d88de72
C
355 return
356 }
357 }
99941732
WL
358}
359
360PeerTubeEmbed.main()
902aa3a0 361 .catch(err => console.error('Cannot init embed.', err))